Skip to main content

Toggl Entry - CLI REST API client for Toggl

Project description

Toggl Entry (te)

Toggle Entry (te) is a Toggl REST API command line interface (CLI) client. This tool allows quick entries insertion from your terminal - no more tedious mouse-clicking!

For any power user, this will be probably much faster way than inserting entries with the official web/desktop/mobile version of the app. Moreover, it can nicely speed-up bulk editing via shell script edited in your favorite editor. Actually, this is how I am catching up with my timesheets ;-)

Toggl Entry screenshot

Requirements

  • Windows, macOS, Linux, or any Unix-like operating system
  • Python 3 + pip (tested with Python 3.7)
  • Toggl account + Toggl API token

You can get the Toggl API token in its web interface from Profile Settings (scroll to the bottom).

Installation

  1. Install te from PyPI (Python Package Index):

    $ pip3 install te
    
  2. Create a configuration file .te.ini in your home directory:

    $ touch ~/.te.ini
    
  3. Set permissions to your configuration file, so nobody but you can read it:

    $ chmod 0600 ~/.te.ini
    
  4. Open the configuration file:

    $ nano  ~/.te.ini
    
  5. Insert this template to the configuration file:

    [general]
    
    ; Set your timezone here
    timezone = Europe/Prague
    
    ; Set your API token here
    api_token = ...
    
  6. Adjust the timezone and api_token in the configuration file and save it.

Usage

Open your terminal application and try this command:

$ te 20-01-30 08:00 1h My first task entry

If no error message is provided and the process gracefully exits, the entry has been successfully inserted. You can check it in the Toggl web app.

You can also use this format to automatically insert the current date:

$ te - 08:00 120m My first task entry

Also, the separators can be avoided:

$ te 200130 0800 3h My first task entry

That's it for now and happy Toggl-ing!

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for te, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size te-1.0.1-py3-none-any.whl (5.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size te-1.0.1.tar.gz (216.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page