Skip to main content

A simple Command line application helping you play with timelogs of configured redmine server.

Project description

Minetime is a command line application to help you collect timelogs and post them to a configured Redmine project management application via its REST API, using the python-redmine library.

Features

  • Interactive wizard. In wizard mode, user gets to select issues from assigned issues and tracked queries, add, delete, edit, merge or round timelogs.
  • GTimelog integration.
  • Universal Time Tracker integration.
  • Project Report created to expose minetime project time entries per version. Optimized for redmine with Backlog Plugin.
Basics:

minetime Homepage, minetime Documentation

Package & Build Status:
 https://badge.fury.io/py/minetime.svg https://gitlab.com/yakoi/minetime/badges/master/build.svg https://gitlab.com/yakoi/minetime/badges/master/coverage.svg
License:

GPL License

Issue tracker:

Gitlab Issues

Installation

# install minetime
pip install minetime

# upgrade minetime
pip install --upgrade minetime

or, without pip, from source:

python setup.py install

Main Configuration File

Default location: $HOME/.config/minetime/config.yml. Format: YAML

The default location may be overwritten by the MINETIME_CONF environment variable.

Here’s an example of the main configuration file:

general:
  uri: https://redmine.mydomain.com/
user:
  api_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  activity_id: 9
tracked_queries:
- 10001
- 10002
- 10003
tracked_reports:
- my_report_string_id
activities:
  9: Developpement

Configuration directory and file are not created upon installation. You may create them manually or launch minetime for the first time and the configuration wizard will kick in.

You can find your API key on your redmine account page ( /my/account ) when logged in, on the right-hand pane of the default layout. Rest API has to be activated on the redmine instance. See Redmine Rest API Documentation for more in depth details.

Using minetime

minetime --help

Usage: minetime [OPTIONS] [INPUT]

Options:
  -a, --all                       Import all timelogs in --batch, regardless
                                  of --date.
  -d, --date TEXT                 YYYY-MM-DD date of timelogs, default: today.
  -b, --batch [gtl|utt]           Read GTimelog|utt from input. See GTimelog
                                  integration documentation.
  -t, --timelog <INTEGER FLOAT TEXT INTEGER>...
                                  ISSUEID, HOURS, COMMENTS, ACTIVITYID
                                  HOURS: decimal float (0.25 : 15 minutes).
  -i, --issues                    Show issues and exit. See GTimelog
                                  integration documentation.
  -r, --report                    Project Time Report for any tracked projects
                                  or manually-fed project-string.
  --debug                         Enable debug logging.
  --version                       Show the version and exit.
  --help                          Show this message and exit.

Interactive CLI Wizard:

minetime

Example feeding 2 timelogs from command line:

minetime -t 123 0.75 "first time log", 9 -t 321 1.5 "second time log", 9

Example importing gtimelog flat file:

minetime -b gtl $HOME/.local/share/gtimelog/timelog.txt

Note that this will import today’s timelogs. Use --date to specify another day to import or --all to import everything found in input file.

Project Report:

minetime -r git-helloworld

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
minetime-0.2.9.tar.gz (49.8 kB) Copy SHA256 hash SHA256 Source None

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 SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page