Skip to main content
# todoist-tracker

This project is intended to make it easy to track various metrics for todoist,
including things like:

* how many tasks are currently OVERDUE (including today)
* how much time is allocated to currently OVERDUE (including today) tasks
* the priority level of currently OVERDUE (including today) tasks

`todoist-tracker` is a hack to make it easy to quickly gauge how "underwater"
you are and how productive you've been. It is intended to be set up as a
cronjob with a crontab entry like:

```
45 21 * * * todoist-tracker overdue n
45 21 * * * todoist-tracker overdue time
45 21 * * * todoist-tracker overdue priority
```

which runs `todoist-tracker` every night at 9:45 p.m. By default, the resulting
metrics are stored in a google spreadsheet for subsequent analysis. Depending
on the version of `requests` that is installed via python dependencies, you may
also want to use `PYTHONWARNINGS=ignore` somewhere in your crontab to avoid
being sent warnings every time the script is run.

## quick start

1. install `todoist-tracker` from pypi:
```sh
pip install todoist-tracker
```

1. get your todoist api token from the todoist `Settings` > `Account` > `API
token`.

1. place your todoist api token in a `todoist.json` file in the repository root
that looks like this:
```json
{
"token": "your-token"
}
```

1. get your google spreadsheet credentials by following [the gspread
instructions](http://gspread.readthedocs.io/en/latest/oauth2.html).

1. place your google spreadsheet credentials in a `google.json` file in the
repository root and add your `workbook_url` to the JSON:
```json
{
...
"workbook_url": "https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit#gid=0"
}
```

1. :boom: For usage instructions, see
```sh
todoist-tracker -h
```

## development

1. instantiate virtual environment
```sh
mkvirtualenv todoist-tracker
pip install -r requirements/python-dev
```

1. add the `bin/` directory to your virtualenv `PATH` and the
project root to your `PYTHONPATH` with
```sh
# setup paths on virtualenv activation
echo 'export __PATH_TODOIST_TRACKER=$PATH' > ~/.virtualenvs/todoist-tracker/bin/postactivate
echo 'export PATH=$PATH:'`pwd`'/bin' >> ~/.virtualenvs/todoist-tracker/bin/postactivate
echo 'export PYTHONPATH=$PYTHONPATH:'`pwd` >> ~/.virtualenvs/todoist-tracker/bin/postactivate

# setup paths on virtualenv deactivation
echo 'unset PYTHONPATH' > ~/.virtualenvs/todoist-tracker/bin/predeactivate
echo 'export PATH=$__PATH_TODOIST_TRACKER' > ~/.virtualenvs/todoist-tracker/bin/predeactivate
```

1. follow the quick start instructions above to get your todoist credentials.

Release files for todoist-tracker 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for todoist-tracker 0.1.3
File Size Uploaded
todoist-tracker-0.1.3.tar.gz 6.7 kB Details

Release files / todoist-tracker-0.1.3.tar.gz

Download URL todoist-tracker-0.1.3.tar.gz
Size 6.7 kB
Tags Source
SHA-256 checksum
How to use checksums
8aa5f761a15d9a969f06817caa091a73138f7705b092eaf3c2ea58eadba53f1e
BLAKE2b-256 checksum
How to use checksums
93c1ab6d00a353524dd26e4f948ca82033193322a47d178f61fd9ae23eee9c09
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.3 This release

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page