Models

class JiraConnection(id, label, api_url, username, password, story_points_field)[source]
label

Used solely for displaying the Jira Connection to the user.

api_url

The API URL used for making requests to the Jira backend.

username

The username used for the authentication at the API.

password

The password used for the authentication at the API.

story_points_field

The name of the field the Jira backend uses to store the story points.

get_client() jira.client.JIRA[source]

Authenticate at the jira backend and return a client to communicate with it.

create_stories(query_string: str, poker_session: Optional[planning_poker.models.PokerSession] = None, client: Optional[jira.client.JIRA] = None) List[planning_poker.models.Story][source]

Fetch issues from the Jira client with the given query string and add them to the poker session.

Parameters
  • query_string – The string which should be used to query the stories.

  • poker_session – The poker session to which the stories should be added.

  • client – The jira client which should be used to import the stories. Optional.

Returns

A list containing the created stories.