From 1337dc9f80cb5dd4577b44fce00c9af378b2e9b4 Mon Sep 17 00:00:00 2001 From: Aaron Gutierrez Date: Tue, 13 Mar 2018 08:40:08 -0700 Subject: [PATCH] Cleanup documentation --- .gitignore | 2 ++ README.md | 34 ++++++++++++++++++++++++++++------ requirements.txt | 8 -------- 3 files changed, 30 insertions(+), 14 deletions(-) diff --git a/.gitignore b/.gitignore index 6640103..d61e3ad 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,8 @@ *.swp *.pyc +__pycache__ + tags venv diff --git a/README.md b/README.md index cbfc928..b910bd7 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,38 @@ # cmdasana A curses CLI for Asana, using the Asana API. -Requirments: +## Requirments +* python 3 * [python-asana](https://github.com/Asana/python-asana) -* [urwid (included)](http://urwid.org) -* python 2 +* [urwid](http://urwid.org) +* [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. Copy and paste your OAuth key into the terminal to get started. + +## Navigation +Use arrow keys to navigate, `` to "click", and `` to return to +the previous page. diff --git a/requirements.txt b/requirements.txt index ea7663b..3c2960c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,11 +1,3 @@ asana==0.7.0 -certifi==2018.1.18 -chardet==3.0.4 -idna==2.6 -oauthlib==2.0.6 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