moic.plugins.jira.utils package

Submodules

moic.plugins.jira.utils.base module

Module for base Moic cli utils function

class moic.plugins.jira.utils.base.Board(json_board: dict)

Bases: object

Class representing a Jira Board

moic.plugins.jira.utils.base.get_board_sprints(board_id: str, closed: bool = False) → dict

Return le sprint list of a board

Parameters:

• board_id (str) – The Jira Board ID
• closed (bool) – Indicate if we should returned only opened sprints

Returns:

Dict {“board_id”: id, “sprints”: list} of sprints

Return type:

dict

moic.plugins.jira.utils.base.get_project_boards(project_key: str) → list

Get the board list of a given project

This function is used waiting the 3.0.0 release of Python Jira which include it built-in

Parameters:project_Key (str) – The Jira project Key used to filtered Returns:A list of boards dict Return type:list

moic.plugins.jira.utils.base.get_sprint_issues(sprint_id: str) → jira.client.ResultList

Returns list of Jira Issues linked to a given Jira Sprint

Parameters:sprint_id (str) – Jira Sprint ID

Returns

ResultList: List Jira Issues contained into the sprint

moic.plugins.jira.utils.base.get_sprint_story_points(sprint_id: str) → dict

Return the detailled list of story points for a given sprint Id Splitted between done points and todo points

Parameters:sprint_id (str) – Jira Sprint ID Returns:{“sprint_id”: id, “points”: {“todo”: float, “done”: float}} Return type:dict

moic.plugins.jira.utils.base.sort_issue_per_status(issues: list, project: str = None) → list

Sort an issue liste based on the project defined workflow

Parameters:

• issues (list) – The list of Jira issues to sort
• project (str) – The Jira project key

Returns:

The sorted Jira issues list

Return type:

list

moic.plugins.jira.utils.parser module

Module for a Jira Textile like to Markdown parser

class moic.plugins.jira.utils.parser.BlockElement(raw: str, content: str = '', content_type: str = None, content_style: str = None, oneline: bool = False)

Bases: moic.plugins.jira.utils.parser.JiraElement

This class represent block part element such as code snippets They could be multiline or note

class moic.plugins.jira.utils.parser.HeadElement(raw, content: str = None, level: int = 1)

Bases: moic.plugins.jira.utils.parser.JiraElement

This class represents Header element

class moic.plugins.jira.utils.parser.JiraDocument(raw: str)

Bases: object

Class wich represent a Jira Rich text field such as an Issue Description or comment It provides methods to convert it to Markdown and prepare it for rendering through Rich

HEAD_COLORS = ['dodger_blue3', 'dodger_blue2', 'dodger_blue1', 'deep_sky_blue3', 'deep_sky_blue2', 'deep_sky_blue1', 'bright_blue']

isoneline(line: str)

Check if the given line is a oneline block With a pair of {quote|code|etc…} tags

Parameters:line (str) – The line to check

class moic.plugins.jira.utils.parser.JiraElement

Bases: object

A root custom JiraElement It represent any kind of element

class moic.plugins.jira.utils.parser.ListItemElement(raw: str, content: str = '', level: int = 1, item_type: str = '*')

Bases: moic.plugins.jira.utils.parser.JiraElement

Class representing a list item such as: * item

class moic.plugins.jira.utils.parser.NewLineElement

Bases: moic.plugins.jira.utils.parser.JiraElement

Class representing an emtpy line

class moic.plugins.jira.utils.parser.QuoteElement(raw, content: str = None)

Bases: moic.plugins.jira.utils.parser.JiraElement

Class representing a quote (tag bq. in Jira)

class moic.plugins.jira.utils.parser.TextElement(raw: str)

Bases: object

Module contents

Module for cli utils function