$ pip install python-redmine

$ git clone git://github.com/maxtepkeev/python-redmine.git

$ python setup.py install

$ pip install git+https://github.com/maxtepkeev/python-redmine.git@master

from redminelib import Redmine

redmine = Redmine('https://redmine.url')

redmine = Redmine('https://redmine.url', version='5.0.4')

redmine = Redmine('https://redmine.url', username='foo', password='bar')

redmine = Redmine('https://redmine.url', key='b244397884889a29137643be79c83f1d470c1e2fac')

redmine = Redmine('https://redmine.url', impersonate='jsmith')

'2013-12-31'           -> datetime.date(2013, 12, 31)
'2013-12-31T13:27:47Z' -> datetime.datetime(2013, 12, 31, 13, 27, 47)

datetime.date(2013, 12, 31)                 -> '2013-12-31'
datetime.datetime(2013, 12, 31, 13, 27, 47) -> '2013-12-31T13:27:47Z'

redmine = Redmine('https://redmine.url', date_format='%d.%m.%Y', datetime_format='%d.%m.%YT%H:%M:%SZ')

redmine = Redmine('https://redmine.url', timezone='-0930')

from datetime import timezone
redmine = Redmine('https://redmine.url', timezone=timezone.utc)

from zoneinfo import ZoneInfo
redmine = Redmine('https://redmine.url', timezone=ZoneInfo('America/Los_Angeles'))

'2013-12-31T13:27:47Z' -> datetime.datetime(2013, 12, 31, 5, 27, 47, tzinfo=zoneinfo.ZoneInfo(key='America/Los_Angeles'))

datetime.datetime(2013, 12, 31, 5, 27, 47, tzinfo=zoneinfo.ZoneInfo(key='America/Los_Angeles')) -> '2013-12-31T13:27:47Z'

redmine = Redmine('https://redmine.url', raise_attr_exception=False)

redmine = Redmine('https://redmine.url', raise_attr_exception=('Project', 'Issue', 'WikiPage'))

redmine = Redmine('https://redmine.url', requests={'verify': False})

>>> redmine.project
<redminelib.managers.ResourceManager object for Project resource>
>>> redmine.issue
<redminelib.managers.ResourceManager object for Issue resource>
>>> redmine.user
<redminelib.managers.ResourceManager object for User resource>

>>> project = redmine.project.create(
...     name='Vacation',
...     identifier='vacation',
...     description='foo',
...     homepage='http://foo.bar',
...     is_public=True,
...     parent_id=345,
...     inherit_members=True,
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
... )
>>> project
<redminelib.resources.Project #123 "Vacation">

>>> project = redmine.project.new()
>>> project.name = 'Vacation'
>>> project.identifier = 'vacation'
>>> project.description = 'foo'
>>> project.homepage = 'http://foo.bar'
>>> project.is_public = True
>>> project.parent_id = 345
>>> project.inherit_members = True
>>> project.custom_fields = [{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
>>> project.save()
True

>>> project = redmine.project.get('vacation')
>>> project
<redminelib.resources.Project #123 "Vacation">

>>> projects = redmine.project.all()
>>> projects
<redminelib.resultsets.ResourceSet object with Project resources>

>>> issues = redmine.issue.filter(project_id='vacation')
>>> issues
<redminelib.resultsets.ResourceSet object with Issue resources>

>>> redmine.project.update(123, name='Work', description='Work tasks')
True

>>> redmine.project.delete(1)
True

>>> issues = redmine.issue.search('rom')
<redminelib.resultsets.ResourceSet object with Issue resources>

>>> resources = redmine.search('rom')
{'news': <redminelib.resultsets.ResourceSet object with News resources>,


 'issues': <redminelib.resultsets.ResourceSet object with Issue resources>}

• all. Search all projects.
• my_projects. Search only in user’s projects.
• subprojects. Include subprojects when my_projects specified.

>>> list(redmine.issue.search('rom', titles_only=True, open_issues=True))
[<redminelib.resources.Issue "#123 (New): Romul">,


 <redminelib.resources.Issue "#456 (In Progress): From Russia with Love">]
>>> redmine.search('rom', resources=['issues', 'projects'])
{'issues': <redminelib.resultsets.ResourceSet object with Issue resources>,


 'projects': <redminelib.resultsets.ResourceSet object with Project resources>}

>>> project = redmine.project.get('vacation')
>>> project.id
123
>>> project.name
'Vacation'

>>> project = redmine.project.create(
...     name='Vacation',
...     identifier='vacation',
...     description='foo',
...     homepage='http://foo.bar',
...     is_public=True,
...     parent_id=345,
...     inherit_members=True,
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
... )
>>> project
<redminelib.resources.Project #123 "Vacation">

>>> project = redmine.project.new()
>>> project.name = 'Vacation'
>>> project.identifier = 'vacation'
>>> project.description = 'foo'
>>> project.homepage = 'http://foo.bar'
>>> project.is_public = True
>>> project.parent_id = 345
>>> project.inherit_members = True
>>> project.custom_fields = [{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
>>> project.save()
True

>>> issue = redmine.issue.get(123)
>>> issue.export('pdf', savepath='/home/jsmith')
'/home/jsmith/123.pdf'

>>> issue = redmine.issue.get(123)
>>> issue.export_url('pdf')
'http://demo.redmine.org/issues/123.pdf'

>>> issue = redmine.issue.get(123)
>>> list(issue.project)
[('name', 'FooBar'),


 ('id', 456)]
>>> issue.project.refresh()
>>> list(issue.project)
[('created_on', '2015-12-07T09:19:27Z'),


 ('status', 1),


 ('description', 'A superb project'),


 ('identifier', 'foobar'),


 ('name', 'FooBar'),


 ('homepage', ''),


 ('parent', {'id': 789, 'name': 'Yada'}),


 ('id', 456),


 ('updated_on', '2015-12-07T09:19:27Z')]

>>> issue = redmine.issue.get(123)
>>> issue.url
'http://demo.redmine.org/issues/123'

redmine.project.all()[:135]  # Returns only first 135 projects
redmine.project.all(limit=135)  # Returns only first 135 projects
redmine.issue.filter(project_id='vacation')[10:3]  # Returns only 3 issues starting from 10th
redmine.issue.filter(project_id='vacation', offset=10, limit=3)  # Returns only 3 issues starting from 10th

redmine.project.all(limit=10)[:20]  # Returns 10 projects and not 20

>>> issues = redmine.issue.filter(project_id='vacation', status_id='*')
>>> issues.export('csv', savepath='/home/jsmith', columns='all')
'/home/jsmith/issues.csv'

• exact (exact match)
• in (in a given iterable)

Parameters

>>> from io import BytesIO
>>> issue = redmine.issue.create(
...     project_id='vacation',
...     subject='Vacation',
...     tracker_id=8,
...     description='foo',
...     status_id=3,
...     priority_id=7,
...     assigned_to_id=123,
...     watcher_user_ids=[123],
...     parent_issue_id=345,
...     start_date=datetime.date(2014, 1, 1),
...     due_date=datetime.date(2014, 2, 1),
...     estimated_hours=4,
...     done_ratio=40,
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}],
...     uploads=[{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
... )
>>> issue
<redminelib.resources.Issue #123 "Vacation">

Returns

Resource object

>>> issue = redmine.issue.new()
>>> issue.project_id = 'vacation'
>>> issue.subject = 'Vacation'
>>> issue.tracker_id = 8
>>> issue.description = 'foo'
>>> issue.status_id = 3
>>> issue.priority_id = 7
>>> issue.assigned_to_id = 123
>>> issue.watcher_user_ids = [123]
>>> issue.parent_issue_id = 345
>>> issue.start_date = datetime.date(2014, 1, 1)
>>> issue.due_date = datetime.date(2014, 2, 1)
>>> issue.estimated_hours = 4
>>> issue.done_ratio = 40
>>> issue.custom_fields = [{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
>>> issue.uploads = [{'path': '/absolute/path/to/file'}, {'path': '/absolute/path/to/file2'}]
>>> issue.save()
<redminelib.resources.Issue #123 "Vacation">

Parameters

>>> issue = redmine.issue.get(34441, include=['children', 'journals', 'watchers'])
>>> issue
<redminelib.resources.Issue #34441 "Vacation">

Parameters

>>> issues = redmine.issue.all(sort='category:desc', include=['relations', 'attachments'])
>>> issues
<redminelib.resultsets.ResourceSet object with Issue resources>

Parameters

• author_id (int) – (optional). Get issues which are authored by the given user id.
• assigned_to_id (int) – (optional). Get issues which are assigned to the given user id. To get the issues assigned to the user whose credentials were used to access the API pass me as a string.
• cf_x (string) – (optional). Get issues with given value for custom field with an ID of x. The ~ sign can be used before the value to find issues containing a string in a custom field.
• sort (string) – (optional). Column to sort. Append :desc to invert the order.
• limit (int) – (optional). How much resources to return.
• offset (int) – (optional). Starting from what resource to return the other resources.
• include (list) – .INDENT 2.0
• relations
• attachments (requires Redmine >= 3.4.0)

>>> issues = redmine.issue.filter(
...     project_id='vacation',
...     subproject_id='!*',
...     created_on='><2012-03-01|2012-03-07',
...     cf_22='~foo',
...     sort='category:desc'
... )
>>> issues
<redminelib.resultsets.ResourceSet object with Issue resources>

>>> issues = redmine.issue.filter(
...     project_id='vacation',
...     query_id=326
... )
>>> issues
<redminelib.resultsets.ResourceSet object with Issue resources>

>>> project = redmine.project.get('vacation')
>>> project.issues
<redminelib.resultsets.ResourceSet object with Issue resources>

Added in version 2.5.0.

Apart from issues relation a User resource object provides issues_assigned which is an alias to issues relation and issues_authored relation which returns Issue objects authored by a user:

>>> user = redmine.user.get(9)
>>> user.issues
<redminelib.resultsets.ResourceSet object with Issue resources>
>>> user.issues_assigned
<redminelib.resultsets.ResourceSet object with Issue resources>
>>> user.issues_authored
<redminelib.resultsets.ResourceSet object with Issue resources>

Parameters

>>> from io import BytesIO
>>> redmine.issue.update(
...     1,
...     project_id=1,
...     subject='Vacation',
...     tracker_id=8,
...     description='foo',
...     notes='A journal note',
...     private_notes=True,
...     status_id=3,
...     priority_id=7,
...     assigned_to_id=123,
...     parent_issue_id=345,
...     start_date=datetime.date(2014, 1, 1),
...     due_date=datetime.date(2014, 2, 1),
...     estimated_hours=4,
...     done_ratio=40,
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}],
...     uploads=[{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
... )
True

Returns

Resource object

>>> issue = redmine.issue.get(1)
>>> issue.project_id = 1
>>> issue.subject = 'Vacation'
>>> issue.tracker_id = 8
>>> issue.description = 'foo'
>>> issue.notes = 'A journal note'
>>> issue.private_notes = True
>>> issue.status_id = 3
>>> issue.priority_id = 7
>>> issue.assigned_to_id = 123
>>> issue.parent_issue_id = 345
>>> issue.start_date = datetime.date(2014, 1, 1)
>>> issue.due_date = datetime.date(2014, 2, 1)
>>> issue.estimated_hours = 4
>>> issue.done_ratio = 40
>>> issue.custom_fields = [{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
>>> issue.uploads = [{'path': '/absolute/path/to/file'}, {'path': '/absolute/path/to/file2'}]
>>> issue.save()
<redminelib.resources.Issue #1 "Vacation">

>>> issue = redmine.issue.get(1).save(
...     project_id=1,
...     subject='Vacation',
...     tracker_id=8,
...     description='foo',
...     notes='A journal note',
...     private_notes=True,
...     status_id=3,
...     priority_id=7,
...     assigned_to_id=123,
...     parent_issue_id=345,
...     start_date=datetime.date(2014, 1, 1),
...     due_date=datetime.date(2014, 2, 1),
...     estimated_hours=4,
...     done_ratio=40,
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}],
...     uploads=[{'path': '/absolute/path/to/file'}, {'path': '/absolute/path/to/file2'}]
... )
>>> issue
<redminelib.resources.Issue #1 "Vacation">

Parameters

resource_id (int) – (required). Issue id.

Returns

True

>>> redmine.issue.delete(1)
True

Returns

True

>>> issue = redmine.issue.get(1)
>>> issue.delete()
True

Parameters

•

fields (dict) – (optional). Accepts the same fields as Issue’s create() method to add or modify original values.

>>> copy = redmine.issue.copy(1, project_id='vacation', link_original=False, include=['attachments'])
>>> copy
<redminelib.resources.Issue #124 "Vacation">

Returns

Resource object

>>> issue = redmine.issue.get(123)
>>> copy = issue.copy(subject='this is a copy')
>>> copy
<redminelib.resources.Issue #124 "this is a copy">

Parameters

Returns

String or Object

>>> issue = redmine.issue.get(123)
>>> issue.export('pdf', savepath='/home/jsmith')
'/home/jsmith/123.pdf'

Parameters

Returns

String or Object

>>> issues = redmine.issue.all()
>>> issues.export('csv', savepath='/home/jsmith', filename='issues.csv', columns='all')
'/home/jsmith/issues.csv'

redmine.issue.update(1, notes='new note')
True

>>> issue = redmine.issue.get(1, include=['journals'])
>>> issue.journals
<redminelib.resultsets.ResourceSet object with IssueJournal resources>

>>> issue = redmine.issue.get(1)
>>> issue.journals
<redminelib.resultsets.ResourceSet object with IssueJournal resources>

>>> for journal in issue.journals:
...     print(journal.id, journal.notes)
...
1 foobar
2 lalala
3 hohoho

>>> issue = redmine.issue.get(1, include=['journals'])
>>> for journal in issue.journals:
...     journal.save(notes='setting notes to a new value')
...

>>> redmine.issue_journal.update(1, notes='setting notes to a new value')
True

>>> issue = redmine.issue.get(1, include=['journals'])
>>> for journal in issue.journals:
...     journal.save(notes='')
...

>>> redmine.issue_journal.update(1, notes='')
True

Parameters

user_id (int) – (required). User id.

Returns

True

>>> issue = redmine.issue.get(1)
>>> issue.watcher.add(1)
True

Parameters

user_id (int) – (required). User id.

Returns

True

>>> issue = redmine.issue.get(1)
>>> issue.watcher.remove(1)
True

Parameters

Returns

Resource object

>>> project = redmine.project.create(
...     name='Vacation',
...     identifier='vacation',
...     description='foo',
...     homepage='http://foo.bar',
...     is_public=True,
...     parent_id=345,
...     inherit_members=True,
...     tracker_ids=[1, 2],
...     issue_custom_field_ids=[1, 2],
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}],
...     enabled_module_names=['calendar', 'documents', 'files', 'gantt']
... )
>>> project
<redminelib.resources.Project #123 "Vacation">

Returns

Resource object

>>> project = redmine.project.new()
>>> project.name = 'Vacation'
>>> project.identifier = 'vacation'
>>> project.description = 'foo'
>>> project.homepage = 'http://foo.bar'
>>> project.is_public = True
>>> project.parent_id = 345
>>> project.inherit_members = True
>>> project.tracker_ids = [1, 2]
>>> project.issue_custom_field_ids = [1, 2]
>>> project.custom_fields = [{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
>>> project.enabled_module_names = ['calendar', 'documents', 'files', 'gantt']
>>> project.save()
<redminelib.resources.Project #123 "Vacation">

Parameters

>>> project = redmine.project.get('vacation', include=['trackers', 'issue_categories', 'enabled_modules', 'time_entry_activities', 'issue_custom_fields'])
>>> project
<redminelib.resources.Project #123 "Vacation">

Parameters

>>> projects = redmine.project.all(offset=10, limit=100, include=['trackers', 'issue_categories', 'enabled_modules', 'time_entry_activities'])
>>> projects
<redminelib.resultsets.ResourceSet object with Project resources>

Parameters

Returns

True

>>> redmine.project.update(
...     1,
...     name='Vacation',
...     description='foo',
...     homepage='http://foo.bar',
...     is_public=True,
...     parent_id=345,
...     inherit_members=True,
...     tracker_ids=[1, 2],
...     issue_custom_field_ids=[1, 2],
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}],
...     enabled_module_names=['calendar', 'documents', 'files', 'gantt']
... )
True

Returns

Resource object

>>> project = redmine.project.get(1)
>>> project.name = 'Vacation'
>>> project.description = 'foo'
>>> project.homepage = 'http://foo.bar'
>>> project.is_public = True
>>> project.parent_id = 345
>>> project.inherit_members = True
>>> project.tracker_ids = [1, 2]
>>> project.issue_custom_field_ids = [1, 2]
>>> project.custom_fields = [{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
>>> project.enabled_module_names = ['calendar', 'documents', 'files', 'gantt']
>>> project.save()
<redminelib.resources.Project #1 "Vacation">

>>> project = redmine.project.get(1).save(
...     name='Vacation',
...     description='foo',
...     homepage='http://foo.bar',
...     is_public=True,
...     parent_id=345,
...     inherit_members=True,
...     tracker_ids=[1, 2],
...     issue_custom_field_ids=[1, 2],
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}],
...     enabled_module_names=['calendar', 'documents', 'files', 'gantt']
... )
>>> project
<redminelib.resources.Project #1 "Vacation">

Parameters

resource_id (int or string) – (required). Project id or identifier.

Returns

True

>>> redmine.project.delete(1)
True

Returns

True

>>> project = redmine.project.get(1)
>>> project.delete()
True

Parameters

resource_id (int or string) – (required). Project id or identifier.

Returns

True

>>> redmine.project.close(1)
True

Returns

True

>>> project = redmine.project.get(1)
>>> project.close()
True

Parameters

resource_id (int or string) – (required). Project id or identifier.

Returns

True

>>> redmine.project.reopen(1)
True

Returns

True

>>> project = redmine.project.get(1)
>>> project.reopen()
True

Parameters

resource_id (int or string) – (required). Project id or identifier.

Returns

True

>>> redmine.project.archive(1)
True

Returns

True

>>> project = redmine.project.get(1)
>>> project.archive()
True

Parameters

resource_id (int or string) – (required). Project id or identifier.

Returns

True

>>> redmine.project.unarchive(1)
True

Parameters

Returns

String or Object

>>> projects = redmine.project.all()
>>> projects.export('atom', savepath='/home/jsmith', filename='projects.atom')
'/home/jsmith/projects.atom'

Parameters

Returns

Resource object

>>> membership = redmine.project_membership.create(project_id='vacation', user_id=1, role_ids=[1, 2])
>>> membership
<redminelib.resources.ProjectMembership #123>

Returns

Resource object

>>> membership = redmine.project_membership.new()
>>> membership.project_id = 'vacation'
>>> membership.user_id = 1
>>> membership.role_ids = [1, 2]
>>> membership.save()
<redminelib.resources.ProjectMembership #123>

Parameters

resource_id (int) – (required). Project membership id.

Returns

Resource object

>>> membership = redmine.project_membership.get(521)
>>> membership
<redminelib.resources.ProjectMembership #521>

Parameters

Returns

ResourceSet object

>>> memberships = redmine.project_membership.filter(project_id='vacation')
>>> memberships
<redminelib.resultsets.ResourceSet object with ProjectMembership resources>

Parameters

Returns

True

>>> redmine.project_membership.update(1, role_ids=[1, 2])
True

Returns

Resource object

>>> membership = redmine.project_membership.get(1)
>>> membership.role_ids = [1, 2]
>>> membership.save()
<redminelib.resources.ProjectMembership #1>

>>> membership = redmine.project_membership.get(1).save(role_ids=[1, 2])
>>> membership
<redminelib.resources.ProjectMembership #1>

Parameters

resource_id (int) – (required). Project membership id.

Returns

True

>>> redmine.project_membership.delete(1)
True

Returns

True

>>> membership = redmine.project_membership.get(1)
>>> membership.delete()
True

Parameters

• notified_project_ids (list) – (optional). Project IDs for a “selected” mail notification type.
• must_change_passwd (bool) – (optional). Whether user must change password.
• generate_password (bool) – (optional). Whether to generate password for the user.
• send_information (bool) – (optional). Whether to send account information to the user.
• custom_fields (list) – (optional). Custom fields as [{‘id’: 1, ‘value’: ‘foo’}].
• admin (bool) – (optional). Whether to give admin privileges to the user, requires Redmine >= 4.0.0.

>>> user = redmine.user.create(
...     login='jsmith',
...     password='qwerty',
...     firstname='John',
...     lastname='Smith',
...     mail='john@smith.com',
...     auth_source_id=1,
...     mail_notification='selected',
...     notified_project_ids=[1, 2],
...     must_change_passwd=True,
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
... )
>>> user
<redminelib.resources.User #32 "John Smith">

Returns

Resource object

>>> user = redmine.user.new()
>>> user.login = 'jsmith'
>>> user.password = 'qwerty'
>>> user.firstname = 'John
>>> user.lastname = 'Smith'
>>> user.mail = 'john@smith.com'
>>> user.auth_source_id = 1
>>> user.mail_notification = 'selected'
>>> user.notified_project_ids = [1, 2]
>>> user.must_change_passwd = True
>>> user.custom_fields = [{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
>>> user.save()
<redminelib.resources.User #32 "John Smith">

Parameters

>>> user = redmine.user.get(17, include=['memberships', 'groups'])
>>> user
<redminelib.resources.User #17 "John Smith">

Parameters

Returns

ResourceSet object

>>> users = redmine.user.all(offset=10, limit=100)
>>> users
<redminelib.resultsets.ResourceSet object with User resources>

Parameters

• name (string) – (optional). Filter users on their login, firstname, lastname and mail. If the pattern contains a space, it will also return users whose firstname match the first word or lastname match the second word.
• group_id (int) – (optional). Get only members of the given group.
• limit (int) – (optional). How much resources to return.
• offset (int) – (optional). Starting from what resource to return the other resources.

>>> users = redmine.user.filter(offset=10, limit=100, status=3)
>>> users
<redminelib.resultsets.ResourceSet object with User resources>

Parameters

• auth_source_id (int) – (optional). Authentication mode id.
• mail_notification (string) – .INDENT 2.0
• all
• selected
• only_my_events
• only_assigned
• only_owner
• none

>>> redmine.user.update(
...     1,
...     login='jsmith',
...     password='qwerty',
...     firstname='John',
...     lastname='Smith',
...     mail='john@smith.com',
...     status=3,
...     auth_source_id=1,
...     mail_notification='selected',
...     notified_project_ids=[1, 2],
...     must_change_passwd=True,
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
... )
True

Returns

Resource object

>>> user = redmine.user.get(1)
>>> user.login = 'jsmith'
>>> user.password = 'qwerty'
>>> user.firstname = 'John'
>>> user.lastname = 'Smith'
>>> user.mail = 'john@smith.com'
>>> user.status = 3
>>> user.auth_source_id = 1
>>> user.mail_notification = 'selected'
>>> user.notified_project_ids = [1, 2]
>>> user.must_change_passwd = True
>>> user.custom_fields = [{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
>>> user.save()
<redminelib.resources.User #1 "John Smith">

>>> user = redmine.user.get(1).save(
...     login='jsmith',
...     password='qwerty',
...     firstname='John',
...     lastname='Smith',
...     mail='john@smith.com',
...     status=3,
...     auth_source_id=1,
...     mail_notification='selected',
...     notified_project_ids=[1, 2],
...     must_change_passwd=True,
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
... )
>>> user
<redminelib.resources.User #1 "John Smith">

Parameters

resource_id (int) – (required). User id.

Returns

True

>>> redmine.user.delete(1)
True

Returns

True

>>> user = redmine.user.get(1)
>>> user.delete()
True

Parameters

Returns

String or Object

>>> users = redmine.user.all()
>>> users.export('csv', savepath='/home/jsmith', filename='users.csv', columns='all')
'/home/jsmith/users.csv'

Parameters

Returns

Resource object

>>> time_entry = redmine.time_entry.create(
...     issue_id=123,
...     spent_on=datetime.date(2014, 1, 14),
...     hours=3,
...     activity_id=10,
...     user_id=5,
...     comments='hello'
... )
>>> time_entry
<redminelib.resources.TimeEntry #12345>

Returns

Resource object

>>> time_entry = redmine.time_entry.new()
>>> time_entry.issue_id = 123
>>> time_entry.spent_on = datetime.date(2014, 1, 14)
>>> time_entry.hours = 3
>>> time_entry.activity_id = 10
>>> time_entry.user_id = 5
>>> time_entry.comments = 'hello'
>>> time_entry.save()
<redminelib.resources.TimeEntry #12345>

Parameters

resource_id (int) – (required). Id of the time entry.

Returns

Resource object

>>> time_entry = redmine.time_entry.get(374)
>>> time_entry
<redminelib.resources.TimeEntry #374>

Parameters

Returns

ResourceSet object

>>> time_entries = redmine.time_entry.all(offset=10, limit=100)
>>> time_entries
<redminelib.resultsets.ResourceSet object with TimeEntry resources>

Parameters

Returns

ResourceSet object

>>> time_entries = redmine.time_entry.filter(offset=10, limit=100, project_id='vacation', hours='>=8')
>>> time_entries
<redminelib.resultsets.ResourceSet object with TimeEntry resources>

Parameters

Returns

True

>>> redmine.time_entry.update(
...     1,
...     issue_id=123,
...     spent_on=datetime.date(2014, 1, 14),
...     hours=3,
...     activity_id=10,
...     user_id=5,
...     comments='hello'
... )
True

Returns

Resource object

>>> time_entry = redmine.time_entry.get(1)
>>> time_entry.issue_id = 123
>>> time_entry.spent_on = datetime.date(2014, 1, 14)
>>> time_entry.hours = 3
>>> time_entry.activity_id = 10
>>> time_entry.user_id = 5
>>> time_entry.comments = 'hello'
>>> time_entry.save()
<redminelib.resources.TimeEntry #1>

>>> time_entry = redmine.time_entry.get(1).save(
...     issue_id=123,
...     spent_on=datetime.date(2014, 1, 14),
...     hours=3,
...     activity_id=10,
...     comments='hello'
... )
>>> time_entry
<redminelib.resources.TimeEntry #1>

Parameters

resource_id (int) – (required). Time entry id.

Returns

True

>>> redmine.time_entry.delete(1)
True

Returns

True

>>> entry = redmine.time_entry.get(1)
>>> entry.delete()
True

Parameters

Returns

String or Object

>>> entries = redmine.time_entry.all()
>>> entries.export('csv', savepath='/home/jsmith', filename='entries.csv', columns='all')
'/home/jsmith/entries.csv'

Parameters

>>> news = redmine.news.create(title='Foo', description='foobar')
>>> news
<redminelib.resources.News #8 "Foo">

Returns

Resource object

>>> news = redmine.news.new()
>>> news.title = 'Foo'
>>> news.description = 'foobar'
>>> news.save()
<redminelib.resources.News #8 "Foo">

Parameters

>>> news = redmine.news.get(123, include=['comments', 'attachments'])
>>> news
<redminelib.resources.News #123 "Vacation">

Parameters

Returns

ResourceSet object

>>> news = redmine.news.all(offset=10, limit=100)
>>> news
<redminelib.resultsets.ResourceSet object with News resources>

Parameters

Returns

ResourceSet object

>>> news = redmine.news.filter(project_id='vacation')
>>> news
<redminelib.resultsets.ResourceSet object with News resources>

Parameters

Returns

True

>>> redmine.news.update(1, title='Bar', description='barfoo', summary='bar')
True

Returns

Resource object

>>> news = redmine.news.get(1)
>>> news.title = 'Bar'
>>> news.description = 'barfoo'
>>> news.summary = 'bar'
>>> news.save()
<redminelib.resources.News #1 "Bar">

>>> news = redmine.news.get(1).save(
...     title='Bar',
...     description='barfoo',
...     summary='bar'
... )
>>> news
<redminelib.resources.News #1 "Bar">

Parameters

resource_id (int) – (required). News id.

Returns

True

>>> redmine.news.delete(1)
True

Returns

True

>>> news = redmine.news.get(1)
>>> news.delete()
True

Parameters

Returns

String or Object

>>> news = redmine.news.all()
>>> news.export('atom', savepath='/home/jsmith', filename='news.atom')
'/home/jsmith/news.atom'

Parameters

•

delay (int) – (optional). Delay in days for a “precedes” or “follows” relation.

>>> relation = redmine.issue_relation.create(
...     issue_id=12345,
...     issue_to_id=54321,
...     relation_type='precedes',
...     delay=5
... )
>>> relation
<redminelib.resources.IssueRelation #667>

Returns

Resource object

 >>> relation = redmine.issue_relation.new()


 >>> relation.issue_id = 12345


 >>> relation.issue_to_id = 54321


 >>> relation.relation_type = 'precedes'


 >>> relation.delay = 5


 >>> relation.save()
<redminelib.resources.IssueRelation #667>

Parameters

resource_id (int) – (required). Id of the issue relation.

Returns

Resource object

>>> relation = redmine.issue_relation.get(606)
>>> relation
<redminelib.resources.IssueRelation #606>

Parameters

Returns

ResourceSet object

>>> relations = redmine.issue_relation.filter(issue_id=6543)
>>> relations
<redminelib.resultsets.ResourceSet object with IssueRelation resources>

Parameters

resource_id (int) – (required). Issue relation id.

Returns

True

>>> redmine.issue_relation.delete(1)
True

Returns

True

>>> relation = redmine.issue_relation.get(1)
>>> relation.delete()
True

Parameters

• sharing (string) – .INDENT 2.0
• none (default)
• descendants
• hierarchy
• tree
• system

>>> version = redmine.version.create(
...     project_id='vacation',
...     name='Vacation',
...     status='open',
...     sharing='none',
...     due_date=datetime.date(2014, 1, 30),
...     description='my vacation',
...     wiki_page_title='Vacation'
... )
>>> version
<redminelib.resources.Version #235 "Vacation">

Returns

Resource object

>>> version = redmine.version.new()
>>> version.project_id = 'vacation'
>>> version.name = 'Vacation'
>>> version.status = 'open'
>>> version.sharing = 'none'
>>> version.due_date = datetime.date(2014, 1, 30)
>>> version.description = 'my vacation'
>>> version.wiki_page_title = 'Vacation'
>>> version.save()
<redminelib.resources.Version #235 "Vacation">

Parameters

resource_id (int) – (required). Id of the version.

Returns

Resource object

>>> version = redmine.version.get(1)
>>> version
<redminelib.resources.Version #1 "Release 1">

Parameters

Returns

ResourceSet object

>>> versions = redmine.version.filter(project_id='vacation')
>>> versions
<redminelib.resultsets.ResourceSet object with Versions resources>

Parameters

• sharing (string) – .INDENT 2.0
• none (default)
• descendants
• hierarchy
• tree
• system

>>> redmine.version.update(
...     1,
...     name='Vacation',
...     status='open',
...     sharing='none',
...     due_date=datetime.date(2014, 1, 30),
...     description='my vacation',
...     wiki_page_title='Vacation'
... )
True

Returns

Resource object

>>> version = redmine.version.get(1)
>>> version.name = 'Vacation'
>>> version.status = 'open'
>>> version.sharing = 'none'
>>> version.due_date = datetime.date(2014, 1, 30)
>>> version.description = 'my vacation'
>>> version.wiki_page_title = 'Vacation'
>>> version.save()
<redminelib.resources.Version #1 "Vacation">

>>> version = redmine.version.get(1).save(
...     name='Vacation',
...     status='open',
...     sharing='none',
...     due_date=datetime.date(2014, 1, 30),
...     description='my vacation',
...     wiki_page_title='Vacation'
... )
>>> version
<redminelib.resources.Version #1 "Vacation">

Parameters

resource_id (int) – (required). Version id.

Returns

True

>>> redmine.version.delete(1)
True

Returns

True

>>> version = redmine.version.get(1)
>>> version.delete()
True

Parameters

>>> from io import BytesIO
>>> wiki_page = redmine.wiki_page.create(
...     project_id='vacation',
...     title='FooBar',
...     text='foo',
...     parent_title='Yada',
...     comments='bar',
...     uploads=[{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
... )
>>> wiki_page
<redminelib.resources.WikiPage "FooBar">

Returns

Resource object

>>> wiki_page = redmine.wiki_page.new()
>>> wiki_page.project_id = 'vacation'
>>> wiki_page.title = 'FooBar'
>>> wiki_page.text = 'foo'
>>> wiki_page.parent_title = 'Yada'
>>> wiki_page.comments = 'bar'
>>> wiki_page.uploads = [{'path': '/absolute/path/to/file'}, {'path': '/absolute/path/to/file2'}]
>>> wiki_page.save()
<redminelib.resources.WikiPage "FooBar">

Parameters

>>> wiki_page = redmine.wiki_page.get('Photos', project_id='vacation', version=12, include=['attachments'])
>>> wiki_page
<redminelib.resources.WikiPage "Photos">

Parameters

Returns

ResourceSet object

>>> wiki_pages = redmine.wiki_page.filter(project_id='vacation')
>>> wiki_pages
<redminelib.resultsets.ResourceSet object with WikiPage resources>

Parameters

>>> from io import BytesIO
>>> redmine.wiki_page.update(
...     'Foo',
...     project_id='vacation',
...     title='FooBar',
...     text='foo',
...     parent_title='Yada',
...     comments='bar',
...     uploads=[{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
... )
True

Returns

Resource object

>>> wiki_page = redmine.wiki_page.get('Foo', project_id='vacation')
>>> wiki_page.title = 'Bar'
>>> wiki_page.text = 'bar'
>>> wiki_page.parent_title = 'Yada'
>>> wiki_page.comments = 'changed foo to bar'
>>> wiki_page.uploads = [{'path': '/absolute/path/to/file'}, {'path': '/absolute/path/to/file2'}]
>>> wiki_page.save()
<redminelib.resources.WikiPage "Bar">

>>> wiki_page = redmine.wiki_page.get('Foo', project_id='vacation').save(
...     title='Bar',
...     text='bar',
...     parent_title='Yada',
...     comments='changed foo to bar',
...     uploads=[{'path': '/absolute/path/to/file'}, {'path': '/absolute/path/to/file2'}]
... )
>>> wiki_page
<redminelib.resources.WikiPage "Bar">

Parameters

Returns

True

>>> redmine.wiki_page.delete('Foo', project_id=1)
True

Returns

True

>>> wiki = redmine.wiki_page.get('Foo', project_id=1)
>>> wiki.delete()
True

Parameters

Returns

String or Object

>>> wiki = redmine.wiki_page.get('Foo', project_id=1)
>>> wiki.export('pdf', savepath='/home/jsmith')
'/home/jsmith/123.pdf'

Parameters

resource_id (int) – (required). Id of the query.

Returns

Resource object

>>> query = redmine.query.get(654)
>>> query
<redminelib.resources.Query #654 "Done">

Parameters

Returns

ResourceSet object

>>> queries = redmine.query.all(offset=10, limit=100)
>>> queries
<redminelib.resultsets.ResourceSet object with Query resources>

Parameters

Returns

Resource object

>>> f = redmine.file.create(
...     project_id='vacation',
...     path='/absolute/path/to/file',
...     filename='foo.txt',
...     description='foobar',
...     content_type='text/plain',
...     version_id=1
... )
>>> f
<redminelib.resources.File #1 "foo.txt">

Returns

Resource object

>>> f = redmine.file.new()
>>> f.project_id = 'vacation'
>>> f.path = '/absolute/path/to/file'
>>> f.filename = 'foo.txt'
>>> f.description = 'foobar'
>>> f.content_type = 'text/plain'
>>> f.version_id = 1
>>> f.save()
<redminelib.resources.File #1 "foo.txt">

Parameters

resource_id (int) – (required). Id of the file.

Returns

Resource object

>>> f = redmine.file.get(12345)
>>> f
<redminelib.resources.File #12345 "foo.txt">

Parameters

project_id (int or string) – (optional). Get files from the project with given id.

Returns

ResourceSet object

>>> files = redmine.file.filter(project_id='vacation')
>>> files
<redminelib.resultsets.ResourceSet object with File resources>

Parameters

Returns

True

>>> redmine.file.update(
...     1,
...     filename='foo.txt',
...     description='foobar',
...     content_type='text/plain'
... )
True

Returns

Resource object

>>> f = redmine.file.get(1)
>>> f.filename = 'foo.txt'
>>> f.description = 'foobar'
>>> f.content_type = 'text/plain'
>>> f.save()
<redminelib.resources.File #1 "foo.txt">

>>> f = redmine.file.get(1).save(
...     filename='foo.txt',
...     description='foobar',
...     content_type='text/plain'
... )
>>> f
<redminelib.resources.File #1 "foo.txt">

Parameters

resource_id (int) – (required). File id.

Returns

True

>>> redmine.file.delete(12345)
True

Returns

True

>>> f = redmine.file.get(12345)
>>> f.delete()
True

Parameters

resource_id (int) – (required). Id of the attachment.

Returns

Resource object

>>> attachment = redmine.attachment.get(76905)
>>> attachment
<redminelib.resources.Attachment #76905 "1(a).png">

Parameters

Returns

True

>>> redmine.attachment.update(
...     1,
...     filename='foo.txt',
...     description='foobar',
...     content_type='text/plain'
... )
True

Returns

Resource object

>>> attachment = redmine.attachment.get(1)
>>> attachment.filename = 'foo.txt'
>>> attachment.description = 'foobar'
>>> attachment.content_type = 'text/plain'
>>> attachment.save()
<redminelib.resources.Attachment #1 "foo.txt">

>>> attachment = redmine.attachment.get(1).save(
...     filename='foo.txt',
...     description='foobar',
...     content_type='text/plain'
... )
>>> attachment
<redminelib.resources.Attachment #1 "foo.txt">

Parameters

resource_id (int) – (required). Attachment id.

Returns

True

>>> redmine.attachment.delete(76905)
True

Returns

True

>>> attachment = redmine.attachment.get(76905)
>>> attachment.delete()
True

Parameters

resource_id (int) – (required). Id of the issue status.

Returns

Resource object

>>> status = redmine.issue_status.get(1)
>>> status
<redminelib.resources.IssueStatus #1 "Rejected">

Parameters

Returns

ResourceSet object

>>> statuses = redmine.issue_status.all()
>>> statuses
<redminelib.resultsets.ResourceSet object with IssueStatus resources>

Parameters

resource_id (int) – (required). Id of the tracker.

Returns

Resource object

>>> tracker = redmine.tracker.get(1)
>>> tracker
<redminelib.resources.Tracker #1 "Task">

Parameters

Returns

ResourceSet object

>>> trackers = redmine.tracker.all()
>>> trackers
<redminelib.resultsets.ResourceSet object with Tracker resources>

Parameters

>>> enumeration = redmine.enumeration.get(1, resource='time_entry_activities')
>>> enumeration
<redminelib.resources.Enumeration #1 "Documenting">

Parameters

• limit (int) – (optional). How much resources to return.
• offset (int) – (optional). Starting from what resource to return the other resources.

>>> enumerations = redmine.enumeration.filter(resource='time_entry_activities')
>>> enumerations
<redminelib.resultsets.ResourceSet object with Enumeration resources>

Parameters

Returns

Resource object

>>> category = redmine.issue_category.create(project_id='vacation', name='woohoo', assigned_to_id=13)
>>> category
<redminelib.resources.IssueCategory #810 "woohoo">

Returns

Resource object

>>> category = redmine.issue_category.new()
>>> category.project_id = 'vacation'
>>> category.name = 'woohoo'
>>> category.assigned_to_id = 13
>>> category.save()
<redminelib.resources.IssueCategory #810 "woohoo">

Parameters

resource_id (int) – (required). Id of the issue category.

Returns

Resource object

>>> category = redmine.issue_category.get(794)
>>> category
<redminelib.resources.IssueCategory #794 "Malibu">

Parameters

Returns

ResourceSet object

>>> categories = redmine.issue_category.filter(project_id='vacation')
>>> categories
<redminelib.resultsets.ResourceSet object with IssueCategory resources>

Parameters

Returns

True

>>> redmine.issue_category.update(1, name='woohoo', assigned_to_id=13)
True

Returns

Resource object

>>> category = redmine.issue_category.get(1)
>>> category.name = 'woohoo'
>>> category.assigned_to_id = 13
>>> category.save()
<redminelib.resources.IssueCategory #1 "woohoo">

>>> category = redmine.issue_category.get(1).save(
...     name='woohoo',
...     assigned_to_id=13
... )
>>> category
<redminelib.resources.IssueCategory #1 "woohoo">

Parameters

Returns

True

>>> redmine.issue_category.delete(1, reassign_to_id=2)
True

Parameters

reassign_to_id (int) – (optional). When there are issues assigned to the category you are deleting, this parameter lets you reassign these issues to the category with given id.

Returns

True

>>> category = redmine.issue_category.get(794)
>>> category.delete(reassign_to_id=2)
True

Parameters

resource_id (int) – (required). Id of the role.

Returns

Resource object

>>> role = redmine.role.get(4)
>>> role
<redminelib.resources.Role #4 "Waiter">

Parameters

Returns

ResourceSet object

>>> roles = redmine.role.all()
>>> roles
<redminelib.resultsets.ResourceSet object with Role resources>

Parameters

Returns

Resource object

>>> group = redmine.group.create(name='Developers', user_ids=[13, 15, 25])
>>> group
<redminelib.resources.Group #8 "Developers">

Returns

Resource object

>>> group = redmine.group.new()
>>> group.name = 'Developers'
>>> group.user_ids = [13, 15, 25]
>>> group.save()
<redminelib.resources.Group #8 "Developers">

Parameters

>>> group = redmine.group.get(524, include=['memberships', 'users'])
>>> group
<redminelib.resources.Group #524 "DESIGN">

Parameters

Returns

ResourceSet object

>>> groups = redmine.group.all()
>>> groups
<redminelib.resultsets.ResourceSet object with Group resources>

Parameters

Returns

True

>>> redmine.group.update(1, name='Developers', user_ids=[13, 15, 25])
True

Returns

Resource object

>>> group = redmine.group.get(1)
>>> group.name = 'Developers'
>>> group.user_ids = [13, 15, 25]
>>> group.save()
<redminelib.resources.Group #1 "Developers">

>>> group = redmine.group.get(1).save(
...     name='Developers',
...     user_ids=[13, 15, 25]
... )
>>> group
<redminelib.resources.Group #1 "Developers">

Parameters

resource_id (int) – (required). Group id.

Returns

True

>>> redmine.group.delete(1)
True

Returns

True

>>> group = redmine.group.get(1)
>>> group.delete()
True

Parameters

user_id (int) – (required). User id.

Returns

True

>>> group = redmine.group.get(1)
>>> group.user.add(1)
True

Parameters

user_id (int) – (required). User id.

Returns

True

>>> group = redmine.group.get(1)
>>> group.user.remove(1)
True

Parameters

resource_id (int) – (required). Id of the custom field.

Returns

Resource object

>>> field = redmine.custom_field.get(1)
>>> field
<redminelib.resources.CustomField #1 "Vendor">

Parameters

Returns

ResourceSet object

>>> fields = redmine.custom_field.all()
>>> fields
<redminelib.resultsets.ResourceSet object with CustomField resources>

Parameters

• visibility (int) – .INDENT 2.0
• 0 - project
• 1 - public
• 2 - private

>>> contact = redmine.contact.create(
...     project_id='vacation',
...     first_name='Ivan',
...     last_name='Ivanov',
...     middle_name='Ivanovich',
...     company='Ivan Gmbh',
...     phones=['1234567'],
...     emails=['ivan@ivanov.com'],
...     website='ivanov.com',
...     skype_name='ivan.ivanov',
...     birthday=datetime.date(1980, 10, 21),
...     background='some background here',
...     job_title='CEO',
...     tag_list=['vip', 'online'],
...     is_company=False,
...     address_attributes={'street1': 'foo', 'street2': 'bar', 'city': 'Moscow', 'postcode': '111111', 'country_code': 'RU'},
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}],
...     visibility=0,
...     avatar={'path': '/absolute/path/to/file.jpg'}
... )
>>> contact
<redminelib.resources.Contact #1 "Ivan Ivanov">

Returns

Resource object

>>> contact = redmine.contact.new()
>>> contact.project_id = 'vacation'
>>> contact.first_name = 'Ivan'
>>> contact.last_name = 'Ivanov'
>>> contact.middle_name = 'Ivanovich'
>>> contact.company = 'Ivan Gmbh'
>>> contact.phones = ['1234567']
>>> contact.emails = ['ivan@ivanov.com']
>>> contact.website = 'ivanov.com'
>>> contact.skype_name = 'ivan.ivanov'
>>> contact.birthday = datetime.date(1980, 10, 21)
>>> contact.background = 'some background here'
>>> contact.job_title = 'CEO'
>>> contact.tag_list = ['vip', 'online']
>>> contact.is_company = False
>>> contact.address_attributes = {'street1': 'foo', 'street2': 'bar', 'city': 'Moscow', 'postcode': '111111', 'country_code': 'RU'}
>>> contact.custom_fields = [{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
>>> contact.visibility = 0
>>> contact.avatar = {'path': '/absolute/path/to/file.jpg'}
>>> contact.save()
<redminelib.resources.Contact #1 "Ivan Ivanov">

Parameters

>>> contact = redmine.contact.get(12345, include=['notes', 'contacts', 'deals', 'issues', 'projects'])
>>> contact
<redminelib.resources.Contact #12345 "Ivan Ivanov">

Parameters

>>> contacts = redmine.contact.all(offset=10, limit=100, include=['projects'])
>>> contacts
<redminelib.resultsets.ResourceSet object with Contact resources>

Parameters

>>> contacts = redmine.contact.filter(project_id='vacation', assigned_to_id=123, search='Smith', tags='one,two', include=['projects'])
>>> contacts
<redminelib.resultsets.ResourceSet object with Contact resources>

Parameters

• visibility (int) – .INDENT 2.0
• 0 - project
• 1 - public
• 2 - private

>>> redmine.contact.update(
...     12345,
...     first_name='Ivan',
...     last_name='Ivanov',
...     middle_name='Ivanovich',
...     company='Ivan Gmbh',
...     phones=['1234567'],
...     emails=['ivan@ivanov.com'],
...     website='ivanov.com',
...     skype_name='ivan.ivanov',
...     birthday=datetime.date(1980, 10, 21),
...     background='some background here',
...     job_title='CEO',
...     tag_list=['vip', 'online'],
...     is_company=False,
...     address_attributes={'street1': 'foo', 'street2': 'bar', 'city': 'Moscow', 'postcode': '111111', 'country_code': 'RU'},
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}],
...     visibility=0,
...     avatar={'path': '/absolute/path/to/file.jpg'}
... )
True

Returns

Resource object

>>> contact = redmine.contact.get(12345)
>>> contact.first_name = 'Ivan'
>>> contact.last_name = 'Ivanov'
>>> contact.middle_name = 'Ivanovich'
>>> contact.company = 'Ivan Gmbh'
>>> contact.phones = ['1234567']
>>> contact.emails = ['ivan@ivanov.com']
>>> contact.website = 'ivanov.com'
>>> contact.skype_name = 'ivan.ivanov'
>>> contact.birthday = datetime.date(1980, 10, 21)
>>> contact.background = 'some background here'
>>> contact.job_title = 'CEO'
>>> contact.tag_list = ['vip', 'online']
>>> contact.is_company = False
>>> contact.address_attributes = {'street1': 'foo', 'street2': 'bar', 'city': 'Moscow', 'postcode': '111111', 'country_code': 'RU'}
>>> contact.custom_fields = [{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
>>> contact.visibility = 0
>>> contact.avatar = {'path': '/absolute/path/to/file.jpg'}
>>> contact.save()
<redminelib.resources.Contact #12345 "Ivan Ivanov">

>>> contact = redmine.contact.get(12345).save(
...     first_name='Ivan',
...     last_name='Ivanov',
...     middle_name='Ivanovich',
...     company='Ivan Gmbh',
...     phones=['1234567'],
...     emails=['ivan@ivanov.com'],
...     website='ivanov.com',
...     skype_name='ivan.ivanov',
...     birthday=datetime.date(1980, 10, 21),
...     background='some background here',
...     job_title='CEO',
...     tag_list=['vip', 'online'],
...     is_company=False,
...     address_attributes={'street1': 'foo', 'street2': 'bar', 'city': 'Moscow', 'postcode': '111111', 'country_code': 'RU'},
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}],
...     visibility=0,
...     avatar={'path': '/absolute/path/to/file.jpg'}
... )
>>> contact
<redminelib.resources.Contact #12345 "Ivan Ivanov">

Parameters

resource_id (int) – (required). Contact id.

Returns

True

>>> redmine.contact.delete(1)
True

Returns

True

>>> contact = redmine.contact.get(1)
>>> contact.delete()
True

Parameters

Returns

String or Object

>>> contact = redmine.contact.get(123)
>>> contact.export('pdf', savepath='/home/jsmith')
'/home/jsmith/123.pdf'

Parameters

Returns

String or Object

>>> contacts = redmine.contact.all()
>>> contacts.export('csv', savepath='/home/jsmith', filename='contacts.csv')
'/home/jsmith/contacts.csv'

Parameters

project_id (int or string) – (required). Id or identifier of a project.

Returns

True

>>> contact = redmine.contact.get(1)
>>> contact.project.add('vacation')
True

Parameters

project_id (int or string) – (required). Id or identifier of a project.

Returns

True

>>> contact = redmine.contact.get(1)
>>> contact.project.remove('vacation')
True

Parameters

resource_id (int) – (required). Id of the contact tag.

Returns

Resource object

>>> tag = redmine.contact_tag.get(1)
>>> tag
<redminelib.resources.ContactTag #1 "Online">

Parameters

Returns

ResourceSet object

>>> tags = redmine.contact_tag.all()
>>> tags
<redminelib.resultsets.ResourceSet object with ContactTag resources>

Parameters

• created_on (string or date object) – (optional). Date when note was created.
• note_time (string) – (optional). Time when note was created.
• uploads (list) – .INDENT 2.0
• path (required). Absolute file path or file-like object that should be uploaded.
• filename (optional). Name of the file after upload.
• description (optional). Description of the file.
• content_type (optional). Content type of the file.

>>> note = redmine.note.create(
...     project_id='vacation',
...     source_type='Contact',
...     source_id=12,
...     subject='note subject',
...     content='note content',
...     type_id=3,
...     created_on='2023-01-10',
...     note_time='11:11',
...     uploads=[{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
... )
>>> note
<redminelib.resources.Note #123>

Returns

Resource object

>>> note = redmine.note.new()
>>> note.project_id = 'vacation'
>>> note.source_type = 'Contact'
>>> note.source_id = 12
>>> note.subject = 'note subject'
>>> note.content = 'note content'
>>> note.type_id = 3
>>> note.created_on = '2023-01-10'
>>> note.note_time = '11:11'
>>> note.uploads = [{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
>>> note.save()
<redminelib.resources.Note #123>

Parameters

resource_id (int) – (required). Id of the note.

Returns

Resource object

>>> note = redmine.note.get(12345)
>>> note
<redminelib.resources.Note #12345>

Parameters

• created_on (string or date object) – (optional). Date when note was created.
• note_time (string) – (optional). Time when note was created.
• uploads (list) – .INDENT 2.0
• path (required). Absolute file path or file-like object that should be uploaded.
• filename (optional). Name of the file after upload.
• description (optional). Description of the file.
• content_type (optional). Content type of the file.

>>> redmine.note.update(
...     123,
...     subject='note subject',
...     content='note content',
...     type_id=3,
...     created_on='2023-01-10',
...     note_time='11:11',
...     uploads=[{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
... )
True

Returns

Resource object

>>> note = redmine.note.get(123)
>>> note.subject = 'note subject'
>>> note.content = 'note content'
>>> note.type_id = 3
>>> note.created_on = '2023-01-10'
>>> note.note_time = '11:11'
>>> note.uploads = [{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
>>> note.save()
<redminelib.resources.Note #123>

>>> note = redmine.note.get(123).save(
...     subject='note subject',
...     content='note content',
...     type_id=3,
...     created_on='2023-01-10',
...     note_time='11:11',
...     uploads=[{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
... )
>>> note
<redminelib.resources.Note #123>

Parameters

resource_id (int) – (required). Note id.

Returns

True

>>> redmine.note.delete(123)
True

Returns

True

>>> note = redmine.note.get(1)
>>> note.delete()
True

Parameters

Returns

Resource object

>>> deal = redmine.deal.create(
...     project_id='vacation',
...     name='FooBar',
...     contact_id=1,
...     price=1000,
...     currency='EUR',
...     probability=80,
...     due_date=datetime.date(2014, 12, 12),
...     background='some deal background',
...     status_id=1,
...     category_id=1,
...     assigned_to_id=12,
...     custom_fields=[{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
... )
>>> deal
<redminelib.resources.Deal #123>

Returns

Resource object

>>> deal = redmine.deal.new()
>>> deal.project_id = 'vacation'
>>> deal.name = 'FooBar'
>>> deal.contact_id = 1
>>> deal.price = 1000
>>> deal.currency = 'EUR'
>>> deal.probability = 80
>>> deal.due_date = datetime.date(2014, 12, 12)
>>> deal.background = 'some deal background'
>>> deal.status_id = 1
>>> deal.category_id = 1
>>> deal.assigned_to_id = 12
>>> deal.custom_fields = [{'id': 1, 'value': 'foo'}, {'id': 2, 'value': 'bar'}]
>>> deal.save()
<redminelib.resources.Deal #123>

Parameters

>>> deal = redmine.deal.get(123, include=['notes'])
>>> deal
<redminelib.resources.Deal #123>

Parameters

Returns

ResourceSet object

>>> deals = redmine.deal.all(limit=50)
>>> deals
<redminelib.resultsets.ResourceSet object with Deal resources>

Parameters

Returns

ResourceSet object

>>> deals = redmine.deal.filter(project_id='vacation', assigned_to_id=123, status_id=1, search='Smith')
>>> deals
<redminelib.resultsets.ResourceSet object with Deal resources>