https://github.com/sandinmyjoints/org-pivotal
org-pivotal is an utility to extend org-mode with Pivotal Tracker abilities
https://github.com/sandinmyjoints/org-pivotal
Last synced: 3 months ago
JSON representation
org-pivotal is an utility to extend org-mode with Pivotal Tracker abilities
- Host: GitHub
- URL: https://github.com/sandinmyjoints/org-pivotal
- Owner: sandinmyjoints
- License: gpl-3.0
- Created: 2019-03-23T18:22:10.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T19:30:54.000Z (over 1 year ago)
- Last Synced: 2025-02-08T09:12:51.745Z (4 months ago)
- Language: Emacs Lisp
- Homepage: http://org-pivotal.github.io/
- Size: 564 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.org
- Contributing: CONTRIBUTING.md
- License: COPYING
Awesome Lists containing this project
README
[[https://melpa.org/#/org-pivotal][https://melpa.org/packages/org-pivotal-badge.svg]]
[[https://circleci.com/gh/org-pivotal/org-pivotal/tree/master][https://circleci.com/gh/org-pivotal/org-pivotal/tree/master.svg?style=svg]]
[[https://coveralls.io/github/org-pivotal/org-pivotal?branch=master][https://coveralls.io/repos/github/org-pivotal/org-pivotal/badge.svg?branch=master]]
[[https://www.gnu.org/licenses/gpl-3.0][https://img.shields.io/badge/License-GPL%20v3-blue.svg]]
[[http://hits.dwyl.io/org-pivotal/org-pivotal][http://hits.dwyl.io/org-pivotal/org-pivotal.svg]]
[[https://github.com/org-pivotal/org-pivotal/graphs/commit-activity][https://img.shields.io/badge/Maintained%3F-yes-green.svg]]
[[http://makeapullrequest.com][https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square]]
** Summary
org-pivotal is a utility to extend org-mode with Pivotal Tracker abilities
** Screen shots
[[https://github.com/org-pivotal/org-pivotal.github.io/blob/master/assets/screen_shot.png]]
** Initial setup
Before using the tracker you must setup your pivotal API key in Emacs. You can obtain the key from the [[https://www.pivotaltracker.com/profile][Profile]] link in the Pivotal Tracker web application.
After obtaining the ky, you have to manually add it to your .emacs.d or .spacemacs like this:
#+BEGIN_SRC emacs-lisp
(setq org-pivotal-api-token "your-secret-token")
#+END_SRC
If you don't want to set it directly in your Emacs's .el file, you can export it to shell environment and use =getenv= to read it from within Emacs
#+BEGIN_SRC emacs-lisp
(setq org-pivotal-api-token (getenv "PIVOTAL_API_TOKEN"))
#+END_SRC
To enable this package automatically after opening org-mode, add this line to your Emacs's .el file
#+BEGIN_SRC emacs-lisp
(add-hook 'org-mode-hook 'org-pivotal-mode)
#+END_SRC
** Keybindings
| Keybindings | Interactive commands | Description |
|-------------+--------------------------------------------+-----------------------------------------------|
| ~C-c ( i~ | ~M-x org-pivotal-install-project-metadata~ | Install selected project's metadata to buffer |
| ~C-c ( f~ | ~M-x org-pivotal-pull-stories~ | Pull stories to org buffer |
| ~C-c ( p~ | ~M-x org-pivotal-push-story~ | Push current story to Pivotal |
| ~C-c ( t~ | ~M-x org-pivotal-pull-story-tasks~ | Pull current story's tasks |
** Contributing
Yes, please do! See [[./CONTRIBUTING.md][CONTRIBUTING]] for guidelines.
** License
See [[./COPYING][COPYING]]. Copyright (c) 2018 Huy Duong.
** Roadmap
https://www.pivotaltracker.com/n/projects/2451706