https://github.com/auhau/toggl-cli

A simple command-line interface for toggl.com
https://github.com/auhau/toggl-cli

cli python time-tracking toggl

Last synced: about 18 hours ago
JSON representation

A simple command-line interface for toggl.com

• Host: GitHub
• URL: https://github.com/auhau/toggl-cli
• Owner: AuHau
• License: other
• Created: 2012-05-05T12:32:49.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-07-17T08:06:04.000Z (6 months ago)
• Last Synced: 2024-12-20T05:06:29.216Z (10 days ago)
• Topics: cli, python, time-tracking, toggl
• Language: Python
• Homepage: https://toggl.uhlir.dev
• Size: 1.05 MB
• Stars: 366
• Watchers: 11
• Forks: 69
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Toggl CLI

[![PyPI version](https://badge.fury.io/py/togglCli.svg)](https://badge.fury.io/py/togglCli) 

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/togglCli.svg)](https://pypi.org/project/togglCli)

[![PyPI - Downloads](https://img.shields.io/pypi/dm/togglCli.svg)](https://pypi.org/project/togglCli/) 

[![codecov](https://codecov.io/gh/AuHau/toggl-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/AuHau/toggl-cli) 

[![Build Status](https://travis-ci.org/AuHau/toggl-cli.svg?branch=master)](https://travis-ci.org/AuHau/toggl-cli)

> Command line tool and set of Python wrapper classes for interacting with toggl's API

## Install

Easiest way to install this package is through PyPi:

```shell

$ pip install togglCli

```

## Usage

For full overview of Toggl CLI capabilities please see [full documentation](https://toggl.uhlir.dev).

### CLI tool

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 `--help` option. Check out also help pages of the subcommands!

Several examples of commands:

```shell

# Starts tracking new time entry

$ toggl start

# Displays/enable modifications of currently running time entry

$ toggl now

# Lists all projects

$ toggl projects ls

```

### API wrappers

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 `pendulum` for datetime management, but it is compatible with Python's native datetime, so you can use that if you want to.

```python

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()

```

## Contributing

Feel free to dive in, contributions are welcomed! [Open an issue](https://github.com/auhau/toggl-cli/issues/new) or submit PRs.

For PRs please see [contribution guideline](https://github.com/AuHau/toggl-cli/blob/master/CONTRIBUTING.md).

## License

[MIT ©  Adam Uhlir & D. Robert Adams](https://github.com/AuHau/toggl-cli/blob/master/LICENSE)