Command line tool and set of Python wrapper classes for interacting with toggl's API
Project description
Overview
toggl-cli is a command-line interface for toggl.com.
It certainly does not implement the full toggl API, but rather some core functions. The goal is to make using toggl quicker and more efficient for those already familiar with command-line tools.
toggl-cli is written in Python and uses version 8 of the [toggl API](https://github.com/toggl/toggl_api_docs) (thanks to beauraines for the help).
Latest Update
15 Dec 2014: Thanks to [FedericoVaga](https://github.com/FedericoVaga) .togglrc now supports API token authentication. You will need to add api_token to the auth section, and prefer_token to the options section.
11 Nov 2014: Major refactoring into a more MVC OO structure.
30 Oct 2014: Added a feature that starting, stopping, and continuing an entry prints out the time it started or stopped. This requires a new option in ~/.togglrc: time_format = %I:%M%p is the default. See [strftime()](https://docs.python.org/2/library/datetime.html#strftime-and-strptime-behavior) for more options.
Requirements
iso8601 module
pytz module
requests
python-dateutil
Configuration
Upon first running the program, a configuration file ~/.togglrc will be automatically created.
Update that file with your toggl username and password.
Update the timezone entry (e.g. US/Pacific).
#### Continue Behaviour ####
Setting continue_creates to false will cause continue to continue already existing same-day entries as a duration continuation, rather than create a new entry. continue_creates defaults to false for toggl-cli users where .togglrc already exists, and to true for new users as per the default of the toggl web UI.
Limitations
When creating a time entry for a given project, the project must already exist.
Project users, tasks, tags, and users aren’t supported.
Only the default workspace is supported.
Roadmap
See the [issues tracker](https://github.com/drobertadams/toggl-cli/issues)
Usage
Usage: toggl.py [OPTIONS] [ACTION]
- Options:
- -h, --help
show this help message and exit
- -q, --quiet
don’t print anything
- -v, --verbose
print additional info
- -d, --debug
print debugging output
- Actions:
- add DESCR [:WORKSPACE] [@PROJECT | #PROJECT_ID] START_DATETIME (‘d’DURATION | END_DATETIME)
creates a completed time entry
- add DESCR [:WORKSPACE] [@PROJECT | #PROJECT_ID] ‘d’DURATION
creates a completed time entry, with start time DURATION ago
- clients
lists all clients
- continue [from DATETIME | ‘d’DURATION]
restarts the last entry
- continue DESCR [from DATETIME | ‘d’DURATION]
restarts the last entry matching DESCR
- ls
list recent time entries
- now
print what you’re working on now
- workspaces
lists all workspaces
- projects [:WORKSPACE]
lists all projects
- rm ID
delete a time entry by id
- start DESCR [:WORKSPACE] [@PROJECT | #PROJECT_ID] [‘d’DURATION | DATETIME]
starts a new entry
- stop [DATETIME]
stops the current entry
- www
visits toggl.com
DURATION = [[Hours:]Minutes:]Seconds
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for togglCli-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec464046d150ac143d768e6573f397f4e2da768001bcd96303028495e2f03746 |
|
MD5 | 208f3dcebf202e2721fca30f12027c71 |
|
BLAKE2b-256 | ec97efca7cbf97beebefdfb6b4a3f0e50cabbb5a3aa4c985fa237d1afa0b7fd5 |