Agile Data

Added in version 3.1.0.

Requires the RedmineUP Agile plugin (redmine_agile) >= 1.6.0 and the view_agile_queries permission.

Agile data holds story points, sprint, board position and color of a single issue. It is read-only, the plugin takes changes through the issue (see below).

Note

This resource targets RedmineUP’s Agile plugin. For redmine_expert_agile see Expert Agile Data.

Read methods

get

redminelib.managers.ResourceManager.get(resource_id)

Returns agile data of an issue, attributes are None if nothing was set yet.

Parameters:

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

Returns:

Resource object

>>> data = redmine.agile_data.get(42)
>>> data
<redminelib.resources.AgileData #42>
>>> data.story_points, data.agile_sprint_id, data.position
(3, 5, 2)
>>> data.issue
<redminelib.resources.Issue #42 "Foo">

Changing agile data

Story points and sprint are set through the issue with agile_data_attributes. agile_sprint_id is silently dropped by the plugin without the manage_sprints permission. Story points and sprints have to be enabled in the plugin settings to show up on boards and in totals:

>>> redmine.issue.update(42, agile_data_attributes={'story_points': 5, 'agile_sprint_id': 5})
True

Issues of a sprint can be found with the agile_sprints issue filter:

>>> redmine.issue.filter(project_id='scrum', agile_sprints=5)