Python-Redmine

Python-Redmine is a library for communicating with a Redmine project management application. Redmine exposes some of its data via REST API for which Python-Redmine provides a simple but powerful Pythonic API inspired by a well-known Django ORM:

>>> from redminelib import Redmine

>>> redmine = Redmine('http://demo.redmine.org', username='foo', password='bar')
>>> project = redmine.project.get('vacation')

>>> project.id
30404

>>> project.identifier
'vacation'

>>> project.created_on
datetime.datetime(2013, 12, 31, 13, 27, 47)

>>> project.issues
<redminelib.resultsets.ResourceSet object with Issue resources>

>>> project.issues[0]
<redminelib.resources.Issue #34441 "Vacation">

>>> dir(project.issues[0])
['assigned_to', 'author', 'created_on', 'description', 'done_ratio',
'due_date', 'estimated_hours', 'id', 'priority', 'project', 'relations',
'start_date', 'status', 'subject', 'time_entries', 'tracker', 'updated_on']

>>> project.issues[0].subject
'Vacation'

>>> project.issues[0].time_entries
<redminelib.resultsets.ResourceSet object with TimeEntry resources>

Features

• Supports 100% of Redmine API
• Supports external Redmine plugins API
• Supports Python 3.7 - 3.11 and PyPy3
• Supports different request engines
• Extendable via custom resources and custom request engines
• Extensively documented
• Provides ORM-style Pythonic API
• And many more...

Installation

Standard Edition

The recommended way to install is from Python Package Index (PyPI) with pip:

$ pip install python-redmine

Pro Edition

License for a Pro Edition can be bought here. You will receive an email with all the details regarding Pro Edition installation process.

Documentation

Documentation is available at https://python-redmine.com.

Contacts and Support

Support for Standard Edition is provided via GitHub only, while support for Pro Edition is provided both via GitHub and [email protected]. Be sure to write from email that was specified during the purchase procedure.

Copyright and License

Python-Redmine Standard Edition is licensed under Apache 2.0 license. Python-Redmine Pro Edition is licensed under the Python-Redmine Pro Edition 1.0 license. Check the License for details.