Skip to main content

Python Atlassian REST API Wrapper

Project description

Build status PyPI version PyPI - Downloads License Codacy Badge Documentation Status

Documentation

Documentation

Install

$ pip install atlassian-python-api

Examples

More examples in ``examples/`` directory.

Here’s a short example of 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 of 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 IN ("To Do", "In Progress") ORDER BY issuekey'
data = jira.jql(JQL)
print(data)

Also, you can use the Bitbucket module e.g. for getting 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 the 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')

data = sd.get_my_customer_requests()
print(data)

If you want to see the 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)

First of all, I am happy for any PR requests. Let’s fork and provide your changes :) See the Contribution Guidelines for this project for details on how to make changes to this library.

Credits

In addition to all the contributors we would like to thank these vendors:

  • Atlassian for developing such a powerful ecosystem.

  • JetBrains for providing us with free licenses of PyCharm

  • Travis for hosting our continuous integration

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.15.7.tar.gz (71.7 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for atlassian-python-api-1.15.7.tar.gz
Algorithm Hash digest
SHA256 b54cce1ca4bea838a949b4362410b1d717597951e5b7efbfa34ce89bc5df805e
MD5 e9066dd0ee9b5a03603c8924afc2060b
BLAKE2b-256 6b7cceb24fb630cfd657a9f1aab41ada7b76e07ecd43273e1406c1c83569e660

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