============================
Atlassian Python API wrapper
|Build Status| |PyPI version| |PyPI - Downloads| |License| |Codacy Badge|
Documentation
Documentation (beta)
_
.. _Documentation (beta): https://atlassian-python-api.readthedocs.io/en/latest/index.html
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:
.. 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)
Also, you can use the Bitbucket module e.g. for get project list
.. code-block:: python
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:
.. code-block:: python
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:
.. 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/atlassian-api/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
.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/c822908f507544fe98ae37b25518ae3d
:target: https://www.codacy.com/project/gonchik/atlassian-python-api/dashboard
:alt: Codacy Badge
.. |PyPI - Downloads| image:: https://img.shields.io/pypi/dm/atlassian-python-api.svg
:alt: PyPI - Downloads