Cleanup documentation
This commit is contained in:
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,6 +1,8 @@
|
|||||||
*.swp
|
*.swp
|
||||||
*.pyc
|
*.pyc
|
||||||
|
|
||||||
|
__pycache__
|
||||||
|
|
||||||
tags
|
tags
|
||||||
|
|
||||||
venv
|
venv
|
||||||
|
|||||||
34
README.md
34
README.md
@@ -1,16 +1,38 @@
|
|||||||
# cmdasana
|
# cmdasana
|
||||||
A curses CLI for Asana, using the Asana API.
|
A curses CLI for Asana, using the Asana API.
|
||||||
|
|
||||||
Requirments:
|
## Requirments
|
||||||
|
* python 3
|
||||||
* [python-asana](https://github.com/Asana/python-asana)
|
* [python-asana](https://github.com/Asana/python-asana)
|
||||||
* [urwid (included)](http://urwid.org)
|
* [urwid](http://urwid.org)
|
||||||
* python 2
|
* [pyhon-dateutil](https://github.com/dateutil/dateutil/)
|
||||||
|
|
||||||
Usage:
|
## Setup
|
||||||
|
### Create an Asana OAuth app
|
||||||
|
See [instructions from Asana](https://asana.com/developers/documentation/getting-started/auth#register-an-app)
|
||||||
|
on how to create a new app. Use `urn:ietf:wg:oauth:2.0:oob` as the redirect
|
||||||
|
URL.
|
||||||
|
|
||||||
|
Once you create your app, save your client ID and secret in a file `secrets.py`:
|
||||||
|
```python
|
||||||
|
CLIENT_ID='...'
|
||||||
|
CLIENT_SECRET='...'
|
||||||
```
|
```
|
||||||
make
|
|
||||||
./cmdasana.py
|
### Install dependencies
|
||||||
|
Using `pip`:
|
||||||
|
```
|
||||||
|
pip3 install asana urwid python-dateutil
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```
|
||||||
|
./main.py
|
||||||
```
|
```
|
||||||
|
|
||||||
When you first cmdasana, you will need to authorize the app in your browser.
|
When you first cmdasana, you will need to authorize the app in your browser.
|
||||||
Copy and paste your OAuth key into the terminal to get started.
|
Copy and paste your OAuth key into the terminal to get started.
|
||||||
|
|
||||||
|
## Navigation
|
||||||
|
Use arrow keys to navigate, `<enter>` to "click", and `<backspace>` to return to
|
||||||
|
the previous page.
|
||||||
|
|||||||
@@ -1,11 +1,3 @@
|
|||||||
asana==0.7.0
|
asana==0.7.0
|
||||||
certifi==2018.1.18
|
|
||||||
chardet==3.0.4
|
|
||||||
idna==2.6
|
|
||||||
oauthlib==2.0.6
|
|
||||||
python-dateutil==2.6.1
|
python-dateutil==2.6.1
|
||||||
requests==2.18.4
|
|
||||||
requests-oauthlib==0.8.0
|
|
||||||
six==1.11.0
|
|
||||||
urllib3==1.22
|
|
||||||
urwid==2.0.1
|
urwid==2.0.1
|
||||||
|
|||||||
Reference in New Issue
Block a user