Python Redmine

https://github.com/maxtepkeev/python-redmine

Admin

A Python library providing an easy-to-use API for interacting with the Redmine project management...

Tokens:190,878

Snippets:1,446

Trust Score:6.3

License:Apache-2.0

Update:1 week ago

Show doc for...

Tokens:

Raw

### Install from source with setup.py

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/installation.rst

After cloning the repository, install it into site-packages using setup.py.

```bash
$ python setup.py install
```

--------------------------------

### Install via pip from PyPI

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/installation.rst

Recommended way to install the standard edition from PyPI using pip.

```bash
$ pip install python-redmine
```

--------------------------------

### Clone repository from GitHub

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/installation.rst

Get the latest development sources by cloning the GitHub repository.

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

--------------------------------

### Retrieve a resource via get() method

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/introduction.rst

Shows how to fetch a project resource using the get() method of a ResourceManager and access its attributes.

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

--------------------------------

### Get all products with limit

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product.rst

Returns all Product resources, with optional limit and offset parameters. Returns a ResourceSet object.

```python
>>> products = redmine.product.all(limit=50)
>>> products
<redminelib.resultsets.ResourceSet object with Product resources>
```

--------------------------------

### Get Versions from Project Resource

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/version.rst

Alternative way to get versions using the `versions` relation on a Project resource object.

```python
>>> project = redmine.project.get('vacation')
>>> project.versions
<redminelib.resultsets.ResourceSet object with Version resources>
```

--------------------------------

### Install latest stable development version via pip

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/installation.rst

Install the latest stable development version directly from the master branch on GitHub using pip.

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

--------------------------------

### Get a Version by ID

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/version.rst

Fetches a single Version resource by its ID. Returns a Resource object.

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

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product.rst

Returns a single Product resource from the Products plugin by its id. Supports optional includes for associated data.

```APIDOC
## get

### Description
Returns a single Product resource from the Products plugin by its id.

### Method
GET

### Endpoint
`redminelib.managers.ResourceManager.get(resource_id, **params)`

### Parameters
#### Path Parameters
- **resource_id** (int) - Required - Id of the product.

#### Query Parameters
- **include** (list) - Optional - Fetches associated data in one call. Accepted values: attachments

### Request Example
```python
>>> product = redmine.product.get(123, include=['attachments'])
```

### Response
#### Success Response (200)
- **Resource** object

#### Response Example
```python
>>> product
<redminelib.resources.Product #123>
```
```

--------------------------------

### Get a group with get() and include

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/group.rst

Returns a single group resource by its id. The 'include' parameter fetches associated data (memberships, users) in one call.

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

--------------------------------

### Get products via project relation

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product.rst

Shows how to retrieve products directly from a Project resource using the 'products' relation. Returns a ResourceSet object.

```python
>>> project = redmine.project.get('products')
>>> project.products
<redminelib.resultsets.ResourceSet object with Product resources>
```

--------------------------------

### Get All Queries with Pagination

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/query.rst

Returns all Query resources with optional limit and offset parameters for pagination. Returns a ResourceSet object.

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

--------------------------------

### Get All Orders with limit and include

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/order.rst

Returns all Order resources from the Products plugin, with optional limit and include parameters. Returns a ResourceSet object.

```python
>>> orders = redmine.order.all(limit=50, include=['lines'])
>>> orders
<redminelib.resultsets.ResourceSet object with Order resources>
```

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/version.rst

Returns a single Version resource from Redmine by its id.

```APIDOC
## get

### Description
Returns a single Version resource from Redmine by its id.

### Method
GET

### Endpoint
`redminelib.managers.ResourceManager.get(resource_id)`

### Parameters
#### Path Parameters
- **resource_id** (int) - Required - Id of the version.

### Returns
[Resource](../introduction.md#resource) object

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

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product_category.rst

Returns a single ProductCategory resource from the Products plugin by its id.

```APIDOC
## get

### Description
Returns a single ProductCategory resource from the Products plugin by its id.

### Method
get

### Parameters
- **resource_id** (int) - Required - Id of the product category.

### Returns
Resource object

### Example
```python
>>> category = redmine.product_category.get(123)
>>> category
<redminelib.resources.ProductCategory #123>
```
```

--------------------------------

### Get all ProductCategories with all()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product_category.rst

Returns all ProductCategory resources from the Products plugin. Supports optional limit and offset parameters. Returns a ResourceSet object.

```python
>>> categories = redmine.product_category.all(limit=50)
>>> categories
<redminelib.resultsets.ResourceSet object with ProductCategory resources>
```

--------------------------------

### Get all OrderStatus resources

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/order_status.rst

Returns all OrderStatus resources from the Products plugin as a ResourceSet. Supports optional limit and offset parameters.

```python
>>> statuses = redmine.order_status.all()
>>> statuses
<redminelib.resultsets.ResourceSet object with OrderStatus resources>
```

--------------------------------

### get()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/introduction.rst

Returns a single Resource object by integer id or string identifier.

```APIDOC
## get()

### Description
Returns a single Resource object either by integer `id` or by string `identifier`.

### Method
`get()`

### Parameters
- **id** (int) - Required - The integer ID of the resource.
- **identifier** (string) - Required - The string identifier of the resource.

### Request Example
```python
>>> project = redmine.project.get('vacation')
```

### Response
Returns a single Resource object.

### Response Example
```python
>>> project
<redminelib.resources.Project #123 "Vacation">
```
```

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/query.rst

Returns a single Query resource from Redmine by its id. This method is available starting from version 2.1.0.

```APIDOC
## get

### Description
Returns a single Query resource from Redmine by its id.

### Method
GET

### Endpoint
`redmine.query.get(resource_id)`

### Parameters
#### Path Parameters
- **resource_id** (int) - Required - Id of the query.

### Returns
Resource object

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

--------------------------------

### get(resource_id)

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/custom_field.rst

Returns a single CustomField resource from Redmine by its id. This method is available starting from version 2.1.0.

```APIDOC
## get(resource_id)

### Description
Returns a single CustomField resource from Redmine by its id.

### Parameters
- **resource_id** (*int*) – (required) Id of the custom field.

### Returns
- **Resource** – A Resource object representing the CustomField.

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

--------------------------------

### create

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product.rst

Creates a new Product resource with the given fields and saves it to the Products plugin. Returns a Resource object.

```APIDOC
## create

### Description
Creates a new Product resource with the given fields and saves it to the Products plugin.

### Method
create

### Parameters
- **name** (string) - Required - Product name.
- **project_id** (int or string) - Required - Id or identifier of product's project.
- **status_id** (int) - Optional - Product status id: 1 - active, 2 - inactive.
- **code** (string) - Optional - Product code.
- **price** (string) - Optional - Product price.
- **currency** (string) - Optional - Product currency.
- **category_id** (int) - Optional - Product category id.
- **description** (string) - Optional - Product description.
- **tag_list** (list) - Optional - List of tags.
- **custom_fields** (list) - Optional - Custom fields as [{'id': 1, 'value': 'foo'}].
- **image** (dict) - Optional - Image to be used for the product as dict, accepted keys are: path (required), filename (optional).
- **uploads** (list) - Optional - Uploads as [{'': ''}, ...], accepted keys are: path (required), filename (optional), description (optional), content_type (optional).

### Returns
Resource object

### Example
```python
>>> product = redmine.product.create(
...     project_id='products',
...     name='foobar',
...     status_id=2,
...     code='P-001',
...     price='9.99',
...     currency='USD',
...     category_id=8,
...     description='product description',
...     tag_list=['foo', 'bar'],
...     custom_fields=[{'id': 1, 'value': '11'}],
...     image={'path': '/absolute/path/to/file.jpg'},
...     uploads=[{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
... )
>>> product
<redminelib.resources.Product #123>
```
```

--------------------------------

### Get all trackers

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/tracker.rst

Returns all Tracker resources from Redmine. Optional parameters: limit (how many resources to return) and offset (starting from what resource to return the others). Returns a ResourceSet object.

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

--------------------------------

### Get all Deals with limit

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/deal.rst

Returns all Deal resources from the CRM plugin. The 'limit' parameter controls how many resources to return.

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

--------------------------------

### Get a CRM query by ID using redmine.crm_query.get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/crm_query.rst

Retrieves a single CrmQuery resource by its id and required resource type. The resource parameter must be one of contact, deal, invoice, expense, or product, with plugin requirements for the latter three. Returns a Resource object, as shown by the example output.

```python
>>> query = redmine.crm_query.get(1, resource='contact')
>>> query
<redminelib.resources.CrmQuery #1 "By companies">
```

--------------------------------

### Create a ProductCategory with new() and save()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product_category.rst

Creates a new empty ProductCategory resource, sets attributes, and saves it to the Products plugin. Calls pre_create() and post_create() methods. Returns a Resource object.

```python
>>> category = redmine.product_category.new()
>>> category.name = 'Software'
>>> category.code = 'S-001'
>>> category.parent_id = 13
>>> category.save()
<redminelib.resources.ProductCategory #123>
```

--------------------------------

### Get All Projects with Pagination and Includes

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/project.rst

Returns all Project resources with optional limit, offset, and include parameters (Redmine >= 2.6.0). The result is a ResourceSet.

```python
>>> 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>
```

--------------------------------

### all

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product.rst

Returns all Product resources from the Products plugin. Supports pagination via limit and offset parameters.

```APIDOC
## all

### Description
Returns all Product resources from the Products plugin.

### Method
GET

### Endpoint
`redminelib.managers.ResourceManager.all(**params)`

### Parameters
#### Query Parameters
- **limit** (int) - Optional - How much resources to return.
- **offset** (int) - Optional - Starting from what resource to return the other resources.

### Request Example
```python
>>> products = redmine.product.all(limit=50)
```

### Response
#### Success Response (200)
- **ResourceSet** object

#### Response Example
```python
>>> products
<redminelib.resultsets.ResourceSet object with Product resources>
```
```

--------------------------------

### all

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/order.rst

Returns all Order resources from the Products plugin. Supports optional include, limit, and offset parameters.

```APIDOC
## all

### Description
Returns all Order resources from the Products plugin.

### Method
GET

### Endpoint
`redminelib.managers.ResourceManager.all(**params)`

### Parameters
#### Query Parameters
- **include** (list) - Optional - Fetches associated data in one call. Accepted values: lines
- **limit** (int) - Optional - How much resources to return.
- **offset** (int) - Optional - Starting from what resource to return the other resources.

### Request Example
```python
>>> orders = redmine.order.all(limit=50, include=['lines'])
```

### Response
#### Success Response (200)
- **ResourceSet** object

#### Response Example
```python
>>> orders
<redminelib.resultsets.ResourceSet object with Order resources>
```
```

--------------------------------

### Creating a project with redmine.project.create()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/introduction.rst

Creates a new project resource with the given fields, saves it to Redmine, and returns a newly created Resource object. The example shows setting fields like name, identifier, description, homepage, is_public, parent_id, inherit_members, and custom_fields.

```python
>>> 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">
```

--------------------------------

### Create a project membership with new() and save()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/project_membership.rst

Creates an empty ProjectMembership resource, sets attributes, and saves it to Redmine. Calls pre_create() and post_create() methods. Returns a Resource object.

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

--------------------------------

### Get InvoicePayment by ID

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/invoice_payment.rst

Retrieves a single InvoicePayment resource by its ID using the `get` method. Returns a Resource object.

```python
>>> payment = redmine.invoice_payment.get(123)
>>> payment
<redminelib.resources.InvoicePayment #123>
```

--------------------------------

### Create a new Version resource

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/version.rst

Creates a new Version resource with the given fields and saves it to Redmine. Requires project_id and name; optional fields include status, sharing, due_date, description, and wiki_page_title. Returns a Resource object.

```python
>>> 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">
```

--------------------------------

### Filter products by parameters

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product.rst

Returns Product resources matching given lookup parameters (e.g., project_id, author_id, status_id, search, sort). Returns a ResourceSet object.

```python
>>> products = redmine.product.filter(project_id='products', author_id=123, status_id=1, search='prod', sort='created_at:desc')
>>> products
<redminelib.resultsets.ResourceSet object with Product resources>
```

--------------------------------

### Get TimeEntry by ID

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/time_entry.rst

Retrieves a single TimeEntry resource by its ID using the get method. Returns a Resource object.

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

--------------------------------

### Create a new Version resource with new() and save()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/version.rst

Creates an empty Version resource that is saved only when save() is called. Valid attributes are the same as for create(). Returns a Resource object.

```python
>>> 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">
```

--------------------------------

### Get a project membership by id with get()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/project_membership.rst

Returns a single ProjectMembership resource from Redmine by its id. Requires resource_id. Returns a Resource object.

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

--------------------------------

### Create a ProductCategory with create()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product_category.rst

Creates a new ProductCategory resource with the given fields and saves it to the Products plugin. Requires Pro Edition and Products plugin >= 2.1.5. Returns a Resource object.

```python
>>> category = redmine.product_category.create(
...     name='Software',
...     code='S-001',
...     parent_id=13
... )
>>> category
<redminelib.resources.ProductCategory #123>
```

--------------------------------

### Date and datetime conversion examples

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/configuration.rst

Python-Redmine automatically converts Redmine date/datetime strings to Python objects and vice versa. These examples show the conversion in both directions.

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

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

--------------------------------

### Get invoices via project relation

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/invoice.rst

You can also get invoices from a Project, User, Contact, and CrmQuery resource objects directly using the invoices relation.

```python
>>> project = redmine.project.get('invoices')
>>> project.invoices
<redminelib.resultsets.ResourceSet object with Invoice resources>
```

--------------------------------

### new

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product.rst

Creates a new empty Product resource, but saves it to the Products plugin only when save() is called. Also calls pre_create() and post_create() methods of the Resource object. Valid attributes are the same as for create() method.

```APIDOC
## new

### Description
Creates a new empty Product resource, but saves it to the Products plugin only when save() is called. Also calls pre_create() and post_create() methods of the Resource object. Valid attributes are the same as for create() method.

### Method
new

### Parameters
Same as for create() method.

### Returns
Resource object

### Example
```python
>>> product = redmine.product.new()
>>> product.project_id = 'products'
>>> product.name = 'foobar'
>>> product.status_id = 2
>>> product.code = 'P-001'
>>> product.price = '9.99'
>>> product.currency = 'USD'
>>> product.category_id = 8
>>> product.description = 'product description'
>>> product.tag_list = ['foo', 'bar']
>>> product.custom_fields = [{'id': 1, 'value': '11'}]
>>> product.image = {'path': '/absolute/path/to/file.jpg'}
>>> product.uploads = [{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
>>> product.save()
<redminelib.resources.Product #123>
```
```

--------------------------------

### Get IssueRelations from Issue resource

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/issue_relation.rst

Alternative way to get issue relations directly from an Issue resource object using the 'relations' relation. Returns a ResourceSet object.

```python
>>> issue = redmine.issue.get(6543)
>>> issue.relations
<redminelib.resultsets.ResourceSet object with IssueRelation resources>
```

--------------------------------

### Get News via Project relation

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/news.rst

Alternative way to get news for a project by accessing the news relation on a Project resource object. Returns a ResourceSet of News resources.

```python
>>> project = redmine.project.get('vacation')
>>> project.news
<redminelib.resultsets.ResourceSet object with News resources>
```

--------------------------------

### Create a DealCategory with new() and save()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/deal_category.rst

Creates an empty DealCategory resource, sets attributes, then saves it to the CRM plugin. Calls pre_create() and post_create() methods. Returns a Resource object.

```python
>>> category = redmine.deal_category.new()
>>> category.project_id = 'vacation'
>>> category.name = 'Integration'
>>> category.save()
<redminelib.resources.DealCategory #123>
```

--------------------------------

### Get files from a Project resource using files relation

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/file.rst

Alternative way to get files from a project: access the `files` relation on a Project resource object. The result is a ResourceSet object.

```python
>>> project = redmine.project.get('vacation')
>>> project.files
<redminelib.resultsets.ResourceSet object with File resources>
```

--------------------------------

### Create a Product with redmine.product.create()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product.rst

Creates a new Product resource with the given fields and saves it to the Products plugin. Requires Pro Edition and Products plugin >= 2.1.5. The method returns a Resource object.

```python
>>> product = redmine.product.create(
...     project_id='products',
...     name='foobar',
...     status_id=2,
...     code='P-001',
...     price='9.99',
...     currency='USD',
...     category_id=8,
...     description='product description',
...     tag_list=['foo', 'bar'],
...     custom_fields=[{'id': 1, 'value': '11'}],
...     image={'path': '/absolute/path/to/file.jpg'},
...     uploads=[{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
... )
>>> product
<redminelib.resources.Product #123>
```

--------------------------------

### Get a single resource by ID or identifier

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/introduction.rst

Returns a single Resource object using the get() method with an integer ID or string identifier. The output shows the resource representation.

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

--------------------------------

### Create a File with redmine.file.new and save

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/file.rst

Creates a new empty File resource, sets attributes, and saves it to Redmine. Valid attributes are the same as for create(). Returns a Resource object.

```python
>>> 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">
```

--------------------------------

### Get project memberships via Project resource relation

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/project_membership.rst

Alternative way to get project memberships directly from a Project resource object using the memberships relation. Returns a ResourceSet object.

```python
>>> project = redmine.project.get('vacation')
>>> project.memberships
<redminelib.resultsets.ResourceSet object with ProjectMembership resources>
```

--------------------------------

### Create a project membership with create()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/project_membership.rst

Creates a new ProjectMembership resource and saves it to Redmine. Requires project_id, user_id, and role_ids. Returns a Resource object.

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

--------------------------------

### Create a Product with redmine.product.new() and save()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product.rst

Creates a new empty Product resource, but saves it to the Products plugin only when save() is called. Also calls pre_create() and post_create() methods of the Resource object. Valid attributes are the same as for create().

```python
>>> product = redmine.product.new()
>>> product.project_id = 'products'
>>> product.name = 'foobar'
>>> product.status_id = 2
>>> product.code = 'P-001'
>>> product.price = '9.99'
>>> product.currency = 'USD'
>>> product.category_id = 8
>>> product.description = 'product description'
>>> product.tag_list = ['foo', 'bar']
>>> product.custom_fields = [{'id': 1, 'value': '11'}]
>>> product.image = {'path': '/absolute/path/to/file.jpg'}
>>> product.uploads = [{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
>>> product.save()
<redminelib.resources.Product #123>
```

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/attachment.rst

Returns a single Attachment resource from Redmine by its id.

```APIDOC
## get

### Description
Returns a single Attachment resource from Redmine by its id.

### Method
GET

### Endpoint
redmine.attachment.get(resource_id)

### Parameters
#### Path Parameters
- **resource_id** (int) - Required - Id of the attachment.

### Returns
Resource object

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

### Hint
Attachment can be easily downloaded via the provided `download()` method which is a proxy to the `redmine.download()` method which provides several options to control the saving process (see [docs](https://python-redmine.com/advanced/working_with_files.html#download) for details):

```python
>>> attachment = redmine.attachment.get(76905)
>>> filepath = attachment.download(savepath='/usr/local/', filename='image.jpg')
>>> filepath
'/usr/local/image.jpg'
```
```

--------------------------------

### Alternative save syntax with Product.save()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product.rst

Alternative syntax introduced in version 2.1.0. Saves the product with the given attributes and returns the updated Product resource.

```python
>>> product = redmine.product.get(123).save(
...     project_id='products',
...     name='foobar',
...     status_id=2,
...     code='P-001',
...     price='9.99',
...     currency='USD',
...     category_id=8,
...     description='product description',
...     tag_list=['foo', 'bar'],
...     custom_fields=[{'id': 1, 'value': '11'}],
...     image={'path': '/absolute/path/to/file.jpg'},
...     uploads=[{'path': '/absolute/path/to/file'}, {'path': BytesIO(b'I am content of file 2')}]
... )
>>> product
<redminelib.resources.Product #123>
```

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/project_membership.rst

Returns a single ProjectMembership resource from Redmine by its id.

```APIDOC
## get

### Description
Returns a single ProjectMembership resource from Redmine by its id.

### Method
get

### Parameters
- **resource_id** (int) - Required - Project membership id.

### Returns
Resource object

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

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/issue_relation.rst

Returns a single IssueRelation resource from Redmine by its id.

```APIDOC
## get

### Description
Returns a single IssueRelation resource from Redmine by its id.

### Method
get

### Parameters
- **resource_id** (int) - Required - Id of the issue relation.

### Returns
Resource object

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

--------------------------------

### create

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/version.rst

Creates a new Version resource with the given fields and saves it to Redmine. Returns a Resource object.

```APIDOC
## create

### Description
Creates a new Version resource with the given fields and saves it to Redmine.

### Method
create

### Parameters
- **project_id** (int or string) - Required - Id or identifier of version's project.
- **name** (string) - Required - Version name.
- **status** (string) - Optional - Status of the version, one of: open (default), locked, closed.
- **sharing** (string) - Optional - Version sharing, one of: none (default), descendants, hierarchy, tree, system.
- **due_date** (string or date object) - Optional - Expiration date.
- **description** (string) - Optional - Version description.
- **wiki_page_title** (string) - Optional - Version wiki page title.

### Returns
Resource object

### Example
```python
>>> 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">
```
```

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/note.rst

Retrieves a single Note resource from the CRM plugin by its ID.

```APIDOC
## GET note/{resource_id}

### Description
Returns a single Note resource from the CRM plugin by its id.

### Method
GET

### Endpoint
note/{resource_id}

### Parameters
#### Path Parameters
- **resource_id** (int) - Required - Id of the note.

### Response
#### Success Response (200)
- **Resource** - The Note resource object.

#### Response Example
```python
>>> note = redmine.note.get(12345)
>>> note
<redminelib.resources.Note #12345>
```
```

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/invoice_payment.rst

Returns a single InvoicePayment resource from the Invoices plugin by its id.

```APIDOC
## get

### Description
Returns a single InvoicePayment resource from the Invoices plugin by its id.

### Method
GET

### Endpoint
`redminelib.managers.ResourceManager.get(resource_id, **params)`

### Parameters
#### Path Parameters
- **resource_id** (int) - Required - Id of the payment.

### Returns
Resource object

### Example
```python
>>> payment = redmine.invoice_payment.get(123)
>>> payment
<redminelib.resources.InvoicePayment #123>
```
```

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/time_entry.rst

Returns a single TimeEntry resource from Redmine by its id.

```APIDOC
## get

### Description
Returns a single TimeEntry resource from Redmine by its id.

### Method
GET

### Endpoint
redminelib.managers.ResourceManager.get(resource_id)

### Parameters
#### Path Parameters
- **resource_id** (int) - Required - Id of the time entry.

### Returns
Resource object

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

--------------------------------

### Create a Deal with redmine.deal.new() and save()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/deal.rst

Creates a new empty Deal resource that is saved only when save() is called. Also calls pre_create() and post_create() methods. Valid attributes are the same as for create().

```python
>>> 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>
```

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/checklist.rst

Returns a single Checklist resource item from the Checklists plugin by its id.

```APIDOC
## GET

### Description
Returns a single Checklist resource item from the Checklists plugin by its id.

### Method
GET

### Endpoint
`redminelib.managers.ResourceManager.get(resource_id, **params)`

### Parameters
#### Path Parameters
- **resource_id** (int) - Required - Id of the checklist item.

### Request Example
```python
>>> checklist = redmine.checklist.get(123)
>>> checklist
<redminelib.resources.Checklist #123>
```

### Response
#### Success Response (200)
- **Resource** - A Resource object representing the checklist item.

#### Response Example
```python
<redminelib.resources.Checklist #123>
```
```

--------------------------------

### all

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product_category.rst

Returns all ProductCategory resources from the Products plugin.

```APIDOC
## all

### Description
Returns all ProductCategory resources from the Products plugin.

### Method
all

### Parameters
- **limit** (int) - Optional - How much resources to return.
- **offset** (int) - Optional - Starting from what resource to return the other resources.

### Returns
ResourceSet object

### Example
```python
>>> categories = redmine.product_category.all(limit=50)
>>> categories
<redminelib.resultsets.ResourceSet object with ProductCategory resources>
```
```

--------------------------------

### get(resource_id, **params)

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/invoice.rst

Returns a single Invoice resource from the Invoices plugin by its id.

```APIDOC
## get(resource_id, **params)

### Description
Returns a single Invoice resource from the Invoices plugin by its id.

### Method
get

### Endpoint
redminelib.managers.ResourceManager.get(resource_id, **params)

### Parameters
#### Path Parameters
- **resource_id** (int) - Required - Id of the invoice.

### Request Example
```python
>>> invoice = redmine.invoice.get(123)
>>> invoice
<redminelib.resources.Invoice #123>
```

### Response
#### Success Response
- **Resource** (Resource) - The Invoice resource object.
```

--------------------------------

### create

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product_category.rst

Creates a new ProductCategory resource with the given fields and saves it to the Products plugin.

```APIDOC
## create

### Description
Creates a new ProductCategory resource with the given fields and saves it to the Products plugin.

### Method
create

### Parameters
- **name** (string) - Required - Category name.
- **code** (string) - Optional - Category code.
- **parent_id** (int) - Optional - Category parent id.

### Returns
Resource object

### Example
```python
>>> category = redmine.product_category.create(
...     name='Software',
...     code='S-001',
...     parent_id=13
... )
>>> category
<redminelib.resources.ProductCategory #123>
```
```

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/tracker.rst

Returns a single Tracker resource from Redmine by its id. This method is available on the tracker manager.

```APIDOC
## get

### Description
Returns a single Tracker resource from Redmine by its id.

### Method
GET

### Endpoint
`redmine.tracker.get(resource_id)`

### Parameters
#### Path Parameters
- **resource_id** (int) - Required - Id of the tracker.

### Returns
[Resource](../introduction.md#resource) object

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

--------------------------------

### Create a File with redmine.file.create

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/file.rst

Creates a new File resource and saves it to Redmine. Requires project_id and path; optional fields include filename, description, content_type, and version_id. Returns a Resource object.

```python
>>> 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">
```

--------------------------------

### Get IssueCategory by ID

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/issue_category.rst

Retrieves a single IssueCategory resource by its id. Returns a Resource object.

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

--------------------------------

### Create WikiPage with new() and save()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/wiki_page.rst

Creates an empty WikiPage resource that is saved to Redmine only when save() is called. Valid attributes are the same as for create(). The example sets project_id, title, text, parent_title, comments, and uploads, then calls save() to persist the resource.

```python
>>> 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">
```

--------------------------------

### Get Expense by ID

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/expense.rst

Retrieves a single Expense resource by its id. Returns a Resource object.

```python
>>> expense = redmine.expense.get(123)
>>> expense
<redminelib.resources.Expense #123>
```

--------------------------------

### new

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/version.rst

Creates a new empty Version resource but saves it to Redmine only when save() is called. Also calls pre_create() and post_create() methods of the Resource object.

```APIDOC
## new

### Description
Creates a new empty Version resource but saves it to Redmine only when save() is called. Also calls pre_create() and post_create() methods of the Resource object.

### Method
new

### Parameters
Valid attributes are the same as for create() method.

### Returns
Resource object

### Example
```python
>>> 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">
```
```

--------------------------------

### all

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/deal.rst

Returns all Deal resources from the CRM plugin. Supports pagination via limit and offset parameters.

```APIDOC
## all

### Description
Returns all Deal resources from the CRM plugin.

### Method
GET

### Endpoint
`redminelib.managers.ResourceManager.all(**params)`

### Parameters
#### Query Parameters
- **limit** (int) - Optional - How much resources to return.
- **offset** (int) - Optional - Starting from what resource to return the other resources.

### Request Example
```python
redmine.deal.all(limit=50)
```

### Response
#### Success Response (200)
- **ResourceSet** - A ResourceSet object containing Deal resources.

#### Response Example
```python
<redminelib.resultsets.ResourceSet object with Deal resources>
```
```

--------------------------------

### Get all groups with all()

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/group.rst

Returns all Group resources from Redmine. Supports optional 'limit' and 'offset' parameters.

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

--------------------------------

### Get length of ResourceSet

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/introduction.rst

Evaluates the ResourceSet during the len() call and returns its length.

```python
len(redmine.project.all())
```

--------------------------------

### Alternative save syntax (version 2.1.0)

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/project.rst

Introduced in version 2.1.0, this alternative syntax chains .save() directly on the fetched resource, passing fields as arguments. Returns the saved Project resource.

```python
>>> 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">
```

--------------------------------

### new

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product_category.rst

Creates a new empty ProductCategory resource, but saves it to the Products plugin only when save() is called. Also calls pre_create() and post_create() methods of the Resource object.

```APIDOC
## new

### Description
Creates a new empty ProductCategory resource, but saves it to the Products plugin only when save() is called. Also calls pre_create() and post_create() methods of the Resource object.

### Method
new

### Parameters
Valid attributes are the same as for create() method.

### Returns
Resource object

### Example
```python
>>> category = redmine.product_category.new()
>>> category.name = 'Software'
>>> category.code = 'S-001'
>>> category.parent_id = 13
>>> category.save()
<redminelib.resources.ProductCategory #123>
```
```

--------------------------------

### Get attachment by ID

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/attachment.rst

Retrieves a single Attachment resource by its ID. Returns a Resource object.

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

--------------------------------

### Get product by ID with include

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/product.rst

Fetches a single Product resource by its id, optionally including associated data (e.g., attachments) in one call. Returns a Resource object.

```python
>>> product = redmine.product.get(123, include=['attachments'])
>>> product
<redminelib.resources.Product #123>
```

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/news.rst

Returns a single News resource from Redmine by its id. Supports optional includes for associated data.

```APIDOC
## get

### Description
Returns a single News resource from Redmine by its id.

### Method
GET

### Endpoint
`redminelib.managers.ResourceManager.get(resource_id, **params)`

### Parameters
#### Path Parameters
- **resource_id** (int) - Required - News id.

#### Query Parameters
- **include** (list) - Optional - Fetches associated data in one call. Accepted values: comments, attachments.

### Request Example
```python
news = redmine.news.get(123, include=['comments', 'attachments'])
```

### Response
#### Success Response (200)
- **Resource** - A Resource object representing the News.

#### Response Example
```python
<redminelib.resources.News #123 "Vacation">
```
```

--------------------------------

### Recommended vs. not recommended ResourceManager usage

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/introduction.rst

Compares creating a ResourceManager on the fly versus reusing a stored manager object. The recommended approach creates the manager each time, while the not-so-good approach stores it in a variable.

```python
# this is good
>>> p1 = redmine.project.get(1)
>>> p2 = redmine.project.get(2)

# this is not so good
>>> project = redmine.project
>>> p1 = project.get(1)
>>> p2 = project.get(2)
```

--------------------------------

### get

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/issue_status.rst

Returns a single IssueStatus resource from Redmine by its id. This method is available through the manager at redmine.issue_status.

```APIDOC
## get

### Description
Returns a single IssueStatus resource from Redmine by its id.

### Method
GET

### Endpoint
redmine.issue_status.get(resource_id)

### Parameters
#### Path Parameters
- **resource_id** (int) - Required - Id of the issue status.

### Returns
Resource object

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

--------------------------------

### all

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/resources/query.rst

Returns all Query resources from Redmine. Supports pagination via limit and offset parameters.

```APIDOC
## all

### Description
Returns all Query resources from Redmine.

### Method
GET

### Endpoint
`redmine.query.all(**params)`

### Parameters
#### Query Parameters
- **limit** (int) - Optional - How much resources to return.
- **offset** (int) - Optional - Starting from what resource to return the other resources.

### Returns
ResourceSet object

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

--------------------------------

### Import Redmine object

Source: https://github.com/maxtepkeev/python-redmine/blob/master/docs/configuration.rst

Import the Redmine class from the redminelib package to start configuring a connection to a Redmine server.

```python
from redminelib import Redmine
```

Tokens:

Raw