Skip to main content

Python Atlassian REST API Wrapper

Project description

Build status PyPI version PyPI - Downloads License Codacy Badge

Documentation

Documentation (beta)

Examples

For everyday normal use, just install package using pip

pip install atlassian-python-api

Here’s a short example how to create a Confluence page:

from atlassian import Confluence

confluence = Confluence(
    url='http://localhost:8090',
    username='admin',
    password='admin')

status = confluence.create_page(
    space='DEMO',
    title='This is the title',
    body='This is the body. You can use <strong>HTML tags</strong>!')

print(status)

And here’s another example how to get issues from Jira using JQL Query:

from atlassian import Jira

jira = Jira(
    url='http://localhost:8080',
    username='admin',
    password='admin')

JQL = 'project = DEMO AND status NOT IN (Closed, Resolved) ORDER BY issuekey'
data = jira.jql(JQL)
print(data)

Also, you can use the Bitbucket module e.g. for get project list

from atlassian import Bitbucket

bitbucket = Bitbucket(
        url='http://localhost:7990',
        username='admin',
        password='admin')
data = bitbucket.project_list()
print(data)

Now you can use Jira Service Desk module. See docs. Example to get your requests:

from atlassian import ServiceDesk

sd = ServiceDesk(
        url='http://localhost:7990',
        username='admin',
        password='admin')
my_requests = sd.get_my_customer_requests()
print(my_requests)

Please make sure, you’ve checked examples/ directory on how to build scripts using the API. If you want to see response in pretty print format json. Feel free for use construction like:

from pprint import pprint
# you code here
# and then print using pprint(result) instead of print(result)
pprint(response)

Development and Deployment (For contributors)

See the Contribution guidelines for this project for details on how to make changes to this library.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

atlassian-python-api-1.13.3.tar.gz (45.0 kB view details)

Uploaded Source

File details

Details for the file atlassian-python-api-1.13.3.tar.gz.

File metadata

File hashes

Hashes for atlassian-python-api-1.13.3.tar.gz
Algorithm Hash digest
SHA256 8790149d1b588dc9d1492b7b22efd5f8919d3d7fb00578d36fee8b9b9b7d43da
MD5 33ee2c35cca128300ff530a2285d7cf4
BLAKE2b-256 60fbd840483442bd22785d67ad25ed4e5a4b55e3630ce0b0b7c39974913a1287

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page