Python Redmine Library

2.5.0 · active · verified Fri Apr 17

Python-Redmine is a comprehensive library for programmatic interaction with the Redmine project management application. It allows users to manage issues, projects, users, and other Redmine resources through a Pythonic interface. The current version is 2.5.0, with new releases typically coming a few times a year, often including support for RedmineUP's Pro Edition plugins.

Common errors

```
from python_redmine import Redmine
ModuleNotFoundError: No module named 'python_redmine'
```
cause Incorrect import path. The main package for importing classes is `redminelib`, not `python_redmine`.

fix Change your import statement to `from redminelib import Redmine`.
```
redminelib.exceptions.ResourceNotFoundError: The resource you are trying to access doesn't exist.
```
cause Attempted to access a Redmine resource (e.g., issue, project, user) with an ID that does not exist or is inaccessible.

fix Verify the ID you are using is correct and that the user associated with the API key has permissions to view that resource. Check Redmine directly to confirm the resource's existence and visibility.
```
redminelib.exceptions.RedmineError: No 'X-Redmine-API-Key' header found.
```
cause The Redmine API key was not provided or is incorrect, or the Redmine server is not configured to accept API key authentication.

fix Ensure you are passing a valid API key to the `Redmine` constructor (e.g., `key='YOUR_API_KEY'`). Verify that API authentication is enabled in your Redmine server settings (Administration -> Settings -> Authentication -> 'Enable REST API').
```
requests.exceptions.ConnectionError: ('Connection aborted.', ConnectionResetError(104, 'Connection reset by peer'))
```
cause The Redmine URL is incorrect, the server is offline, or there is a network issue preventing connection to the Redmine instance.

fix Double-check the `REDMINE_URL` you are using. Ensure the Redmine server is running and accessible from where you are running your Python code. Verify any firewalls or proxies are not blocking the connection.

Warnings

breaking Python 2.x, 3.3, 3.5, and 3.6 support has been dropped. Python-Redmine now requires Python >= 3.7.
Fix: Upgrade your Python environment to 3.7 or newer. For older Python versions, use python-redmine < 2.2.0 or < 2.4.0 depending on your exact version.
breaking The `requests` package, previously vendored, became an external dependency. If you were relying on it being bundled, your code might fail.
Fix: Ensure `requests` is installed explicitly via `pip install requests` alongside `python-redmine`. This is now handled automatically by `pip install python-redmine`.
gotcha Minimum `requests` version requirements are periodically updated (e.g., to >= 2.31.0 in v2.5.0, >= 2.28.2 in v2.4.0). Using an older `requests` version might lead to dependency conflicts or unexpected behavior.
Fix: Always install the latest `python-redmine` which will pull in a compatible `requests` version, or explicitly update `requests` to meet the library's minimum requirements (e.g., `pip install requests --upgrade`).
gotcha Some features, like the `/my/account` endpoint for non-admin users (`redmine.user.get('me')`), News API, or RedmineUP plugin support, require a minimum Redmine API version.
Fix: Check the Python-Redmine documentation for specific feature requirements. Ensure your Redmine server version meets the minimum required version for the functionality you are trying to use (e.g., Redmine >= 4.1.0 for some `/my/account` and News features).

Install

pip install python-redmine Install stable version

Imports

Redmine
wrong:
```
from python_redmine import Redmine
```
correct:
```
from redminelib import Redmine
```
The top-level package for import is `redminelib`, not `python_redmine`.
RedmineError
```
from redminelib.exceptions import RedmineError
```
Exceptions are in a dedicated submodule.

Quickstart

This quickstart connects to a Redmine instance using an API key, fetches information about the current user, lists the first five projects, and attempts to retrieve a specific issue by ID. Ensure you have your Redmine URL and API key configured.

import os
from redminelib import Redmine
from redminelib.exceptions import ResourceNotFoundError

# Replace with your Redmine URL and API Key
REDMINE_URL = os.environ.get('REDMINE_URL', 'http://localhost:3000')
REDMINE_API_KEY = os.environ.get('REDMINE_API_KEY', 'YOUR_API_KEY_HERE')

try:
    redmine = Redmine(REDMINE_URL, key=REDMINE_API_KEY)
    
    # Get current user
    me = redmine.user.get('current')
    print(f"Connected to Redmine as: {me.firstname} {me.lastname} ({me.login})")

    # Get a list of projects
    projects = redmine.project.all(limit=5)
    print("\nFirst 5 Projects:")
    for project in projects:
        print(f" - {project.name} (ID: {project.id})")
        
    # Try to get a specific issue
    try:
        issue = redmine.issue.get(1)
        print(f"\nIssue #1: {issue.subject} (Status: {issue.status.name})")
    except ResourceNotFoundError:
        print("\nIssue #1 not found.")

except Exception as e:
    print(f"An error occurred: {e}")

view raw JSON →