Skip to main content

Python Atlassian REST API Wrapper

Project description

============================
Atlassian Python API wrapper
============================
|Build Status| |PyPI version| |License|

For users
=========

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:

.. code-block:: python

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:

.. code-block:: python

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)

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:

.. code-block:: python

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.

.. _Contribution guidelines for this project: CONTRIBUTING.rst
.. |Build Status| image:: https://travis-ci.org/AstroMatt/atlassian-python-api.svg?branch=master
:target: https://pypi.python.org/pypi/atlassian-python-api
:alt: Build status
.. |PyPI version| image:: https://badge.fury.io/py/atlassian-python-api.svg
:target: https://badge.fury.io/py/atlassian-python-api
:alt: PyPI version
.. |License| image:: https://img.shields.io/pypi/l/atlassian-python-api.svg
:target: https://pypi.python.org/pypi/atlassian-python-api
:alt: License

Project details


Release history Release notifications | RSS feed

This version

1.9.0

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

Uploaded Source

File details

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

File metadata

File hashes

Hashes for atlassian-python-api-1.9.0.tar.gz
Algorithm Hash digest
SHA256 866810aa3e9fb31b876537e44009eb577948539a4024ebd51f8e32ad0735114b
MD5 5a83ec2862d107ca4b1a3b247019e3ed
BLAKE2b-256 a68ad31afee461fb509fd74def1131843b4229eef853eeb1cd011843cfd718aa

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