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


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-cti-1.12.0.tar.gz (35.0 kB view details)

Uploaded Source

Built Distribution

atlassian_python_api_cti-1.12.0-py3-none-any.whl (38.3 kB view details)

Uploaded Python 3

File details

Details for the file atlassian-python-api-cti-1.12.0.tar.gz.

File metadata

  • Download URL: atlassian-python-api-cti-1.12.0.tar.gz
  • Upload date:
  • Size: 35.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.19.1 setuptools/40.7.2 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.6.8

File hashes

Hashes for atlassian-python-api-cti-1.12.0.tar.gz
Algorithm Hash digest
SHA256 1aeba5365e906d32cec4a072dcd86225a11211e18e664e30d12923bd7f1d1a04
MD5 49687784cc9f11c044492a58726ed914
BLAKE2b-256 7ae19b174d9c13a42b9c7b5ba04e6fedc6ad610c9f770161c8169e035eb8377d

See more details on using hashes here.

File details

Details for the file atlassian_python_api_cti-1.12.0-py3-none-any.whl.

File metadata

  • Download URL: atlassian_python_api_cti-1.12.0-py3-none-any.whl
  • Upload date:
  • Size: 38.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.19.1 setuptools/40.7.2 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.6.8

File hashes

Hashes for atlassian_python_api_cti-1.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f7d1a4cf9ca2675fde0f1a162d9bc670755a8fe44b51602ee1448255cde51144
MD5 e3ec6f0ee6a9ccb5530a5e04c6c5a80e
BLAKE2b-256 dc5ef67f864df6817d8f898ed98ce725f8185ba7d7016ab659b584fa2cd6072c

See more details on using hashes here.

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