impetuous 1.0.0rc0

CLI time tracking software indented for use with JIRA

This is some time/task tracking software. It can talk (barely) to/at JIRA and Freshdesk. 🐑

Requirements

python 3.6

Installation

Install from pypi with pip. Like sudo python3 -m pip install impetuous or python3 -m pip install –user impetuous or something.

Clone the source code and install with python3 -m pip install --user -e .[jira,freshdesk]. If you want. ^{You don’t have to.} _{I’m not the police.}

CLI Usage

The data is stored in a sqlite3 database at ~/.local/share/impetuous/data.sqlite. This can be overridden by setting IM_DB. I think you can even set that to :memory: and it will work. It just probably won’t save your data to disk …

To start doing something, run im doing something. Once you’re not doing anything anymore, run it again but doing tell it what you’re doing; im doing. If you start doing something and you’re already doing a thing, it’ll try to stop the thing you’re doing before starting the new one. You can use -w to specify the date and/or time you’re starting the thing.

im show will list time entries. It uses --since and --until to filter on entries to show. By default, that range is today. Sometimes it’s nice to look at yesterday, so you can pass -y or --yesterday for that. You can provide -y multiple times to keep going back. These time range options should be given after im and before the action (such as doing or show).

--yesterday works by moving back the dates given for --since and --until. It also affects the default date for im doing if all you do is specfiy a time or something.

Many actions can do dry runs with --dry-run.

When all else fails, use im edit to open a YAML representation of your time entries in EDITOR.

im post will post your time entries to an external service you have configured. The responses are saved in the database, so impetuous will remember the result and won’t double-post if you run im post again.

Examples

Here’s a thing: TODO it’s out of date, go record a new one.

It took me three hours to record that without typos … (im start therapy)

Encoding

You can use im encode to get impetuous to encode your passwords in the configuration file. Then it decodes them when it uses them. It supports a few different encodings. You can encode it multiple times. I don’t know why you want to use this. But it’s there now.

Configuration and JIRA and Freskdesk

Edit the configuration by running im config-edit, which just opens the configuration file in ~/.config/impetuous/config.ini in EDITOR. This is an example config.ini:

[jira]
api = jira
server = https://funkymonkey.atlassian.net
basic_auth = admin:hunter2
pattern = ((?:FOO-\d+)|(?:BAR-\d+))

[freshdesk]
api = freshdesk
server = https://funkymonkey.freshdesk.com
api_key = xxxxxxxxxxxxxxxxxxxx
pattern = freskdesk (\d+)
name = sheepdesk
abbr = 🐑

Note

The section names are written into the database and used to track entry postings. If you change the section names, it’ll mess everything up. So don’t do it.

Each section defines an external service for logging time against. The api determines how we can talk to it. You can add multiple sections and call them whatever you want.

By default, the name and abbreviated name are taken from the section name, but you can set them as shown in the “freshdesk” section above.

Development

Versioning

This project does not follow semantic versioning yet as it doesn’t have anything considered to have a public API. The version numbers are entirely arbitrary and meaningless, just like everything else in life.

Tests

Oh man, I don’t know. Just run python3 -m pytest and hope for the best I suppose.

Internationalization / Localization

Maybe?

1. python3 setup.py extract_messages

2. python3 setup.py update_catalog -l fr

3. Modify the translation file ending in .po … if you want

4. python3 setup.py compile_catalog

5. Run with LANGUAGE=fr

You actually only need to do step 4 and 5 to run the program with localization if you don’t want to make modifications.