Skip to main content

A command-line utility to interact with Redmine

Project description

This is a small command-line utility to interact with Redmine

Installation

I suggest you create a virtualenv

Then just use pip or easy_install.

pip install redmine-cli

or

easy_install redmine-cli

Usage

You have to configure the application by getting a REST API key for your Redmine user

Then edit the configuration file in your home directory ( ~/.redmine-cli )

[default]
key=YOUR_REDMINE_REST_API_KEY
my_id=YOUR_REDMINE_USER_ID
root_url=YOUR_REDMINE_ROOT_URL_WITH_PROTOCOL

Example values

[default]
key=c7461a8ed1e4c27b76ce3bec0c0f06f4
my_id=44
root_url=https://redmine.mycompany.com

Command-line syntax

usage: redmine [-h] [--key APIKEY] [--debug] [--root-url ROOT_URL]
               [--user-id USER_ID] [--version]
               {query,issues,open,issue} ...

positional arguments:
  {query,issues,open,issue}
    query               run a saved query by id
    issues              show my issues
    open                open an issue in default browser
    issue               show details on an issue

optional arguments:
  -h, --help            show this help message and exit
  --key APIKEY          set API key
  --debug               write received data in debug.json
  --root-url ROOT_URL   root url of Redmine instance
  --user-id USER_ID     your Redmine user id
  --version             show program's version number and exit

Sample output

+------+----------+-------------+---------------------------+
|  ID  | PRIORITY |    STATUS   |    TITLE                  |
+------+----------+-------------+---------------------------+
| 6534 |   High   | In Progress | Issue 1                   |
| 4081 |  Normal  |   Feedback  | Issue 2                   |
+------+----------+-------------+---------------------------+

Bugs, feature requests, etc…

Please use Github’s issue tracker : https://github.com/yanjost/redmine-cli/issues

Project details


Download files

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

Source Distribution

Redmine-CLI-0.0.3.tar.gz (4.7 kB view details)

Uploaded Source

File details

Details for the file Redmine-CLI-0.0.3.tar.gz.

File metadata

  • Download URL: Redmine-CLI-0.0.3.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Redmine-CLI-0.0.3.tar.gz
Algorithm Hash digest
SHA256 1d3c7e596c013ed5dccf107bf21675790b48689ff520a4ba6d9e6126b70e721c
MD5 1cc09d46c6946b512845c2965110aeca
BLAKE2b-256 e91e0ea203515ee2f6ca5307a533e3834fdfc671ef34d1b1a990728a5bfd4dc0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page