Skip to main content

Jira client

Project description

# Jira Client
This project provides a client library for working with Jira boards, epics, sprints and issues.

## Installation
```
pip install jira-client
```

## Boards
Returns all boards. This only includes boards that you have permission to view.
```python
from jiraclient.jiraclient import JiraClient

# Initialize the Jira client
client = JiraClient("contoso.atlassian.net", "username", "password")

# Get all the boards
boards = client.get_boards()

# Iterate through the list of boards
for board in boards:
print(board.name)
```

Returns the board for the given board identifier. This board will only be returned if you have permission to view it.
```python
board_id = 12345
board = client.get_board(board_id)

print(board.name)
```

## Epics
Returns all epics from the board, for the given board identifier. This only includes epics that you have permission to view. Note, if you don't have permission to view the board, no epics will be returned at all.
```python
# Initialize the Jira client
client = JiraClient("contoso.atlassian.net", "username", "password")

# Specify a board id, start index and max results
board_id = 12345
start_at = 0
max_results = 50

# Get the (first 50) epics
epics = client.get_epics(board_id, start_at, max_results)

# Iterate the list of epics
for epic in epics:
print(epic.name)
```

## Sprints
Returns the sprints for a given board identifier.
```python
client = JiraClient("contoso.atlassian.net", "username", "password")

board_id = 12345
sprints = client.get_sprints_for_board(board_id)

# Iterate the list of sprints
for sprint in sprints:
print('{}: {} - {}'.format(sprint.name, sprint.start_date, sprint.end_date))
```
Returns the active sprint for a given board identifier.
```python
client = JiraClient("contoso.atlassian.net", "username", "password")

board_id = 12345
active_sprint = client.get_active_sprint(board_id)
print(active_sprint.goal)
```
Returns the sprint for a given sprint identifier.
```python
client = JiraClient("contoso.atlassian.net", "username", "password")

sprint_id = 123
sprint = client.get_sprint(sprint_id)
print(sprint.name)
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jira-client, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size jira_client-0.0.3-py2.py3-none-any.whl (14.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size jira-client-0.0.3.tar.gz (7.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page