A simple command-line interface for toggl.com
Command line tool and set of Python wrapper classes for interacting with toggl's API
Easiest way to install this package is through PyPi:
$ pip install togglCli
For full overview of Toggl CLI capabilities please see full documentation.
With first run of the command you will be asked several questions to bootstrap default config file (only UNIX-like system are supported; for Window's users there is created dummy config file, which you have to setup manually).
To get overview of all commands and options please use
--helpoption. Check out also help pages of the subcommands!
Several examples of commands:
# Starts tracking new time entry $ toggl start
Displays/enable modifications of currently running time entry
$ toggl now
Lists all projects
$ toggl projects ls
Toggl CLI comes with set of Python's class wrappers which follow similar pattern like Django ORM.
The wrappers depends on config object which if not provided, the default config file (eq.
~/.togglrc) is used.
Toggl CLI uses
pendulumfor datetime management, but it is compatible with Python's native datetime, so you can use that if you want to.
from toggl import api, utils import pendulum
new_entry = api.TimeEntry(description='Some new time entry', start=pendulum.now() - pendulum.duration(minutes=15), stop=pendulum.now()) new_entry.save()
list_of_all_entries = api.TimeEntry.objects.all()
current_time_entry = api.TimeEntry.objects.current()
Custom config from existing file
config = utils.Config.factory('./some.config')
Custom config without relying on any existing config file
config = utils.Config.factory(None) # Without None it will load the default config file config.api_token = 'your token' config.timezone = 'utc' # Custom timezone
project = api.Project.object.get(123, config=config) project.name = 'Some new name' project.save()
Feel free to dive in, contributions are welcomed! Open an issue or submit PRs.
For PRs please see contribution guideline.