Metadata-Version: 2.1
Name: atlassian-python-api
Version: 3.7.0
Summary: Python Atlassian REST API Wrapper
Home-page: https://github.com/atlassian-api/atlassian-python-api
Author: Matt Harasymczuk
Author-email: matt@astrotech.io
Maintainer: Gonchik Tsymzhitov
Maintainer-email: gonchik.tsymzhitov@gmail.com
License: Apache License 2.0
Download-URL: https://github.com/atlassian-api/atlassian-python-api
Description: ============================
        Atlassian Python API wrapper
        ============================
        |Build Status| |PyPI version| |PyPI - Downloads| |License| |Codacy Badge| |Docs| |Discord|
        
        What is it?
        ___________
        This package is used to provide a **simple** python interface for interacting with Atlassian products
        (Server, Data Center and Cloud) and apps from ecosystem (Portfolio, XRay).
        It is based on the official public Rest API documentation and private methods (+ xml+rpc, raw http request).
        
        Documentation
        _____________
        
        `Documentation`_
        
        .. _Documentation: https://atlassian-python-api.readthedocs.io
        
        How to Install?
        _______________
        
        From PyPI
        
        .. code-block:: console
        
           $ pip install atlassian-python-api
        
        From Source
        
        - Git clone repository
        - Use :code:`pip install -r requirements.txt` to install the required packages
        - or :code:`pipenv install && pipenv install --dev`
        
        Examples
        ________
        More **examples** in :code:`examples/` directory.
        
        Here's a short example of 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 of 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 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
        
        .. 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 the 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')
            
            data = sd.get_my_customer_requests()
            print(data)
        
        Using Xray (Test Management tool for Jira):
        
        .. code-block:: python
        
            from atlassian import Xray
        
            xr = Xray(
                   url='http://localhost:7990',
                    username='admin',
                    password='admin')
            
            data = xr.get_tests('TEST-001')
            print(data)
        
        If you want to see the 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)
        
        How to contribute?
        __________________
        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.
        
        .. _Contribution Guidelines for this project: CONTRIBUTING.rst
        .. |Build Status| image:: https://github.com/atlassian-api/atlassian-python-api/workflows/Test/badge.svg?branch=master
           :target: https://github.com/atlassian-api/atlassian-python-api/actions?query=workflow%3ATest+branch%3Amaster
           :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://pepy.tech/badge/atlassian-python-api/month
           :alt: PyPI - Downloads
        .. |Docs| image:: https://readthedocs.org/projects/atlassian-python-api/badge/?version=latest
           :target: https://atlassian-python-api.readthedocs.io/?badge=latest
           :alt: Documentation Status
        .. |Discord| image:: https://img.shields.io/discord/756142204761669743.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2
           :alt: Discord Chat
           :target: https://discord.gg/FCJsvqh
        
        
        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_
        * Microsoft_ for providing us with free licenses of VSCode_
        * GitHub_ for hosting our repository and continuous integration
        
        .. _Atlassian: https://www.atlassian.com/
        .. _JetBrains: http://www.jetbrains.com
        .. _PyCharm: http://www.jetbrains.com/pycharm/
        .. _GitHub: https://github.com/
        .. _Microsoft: https://github.com/Microsoft/vscode/
        .. _VSCode: https://code.visualstudio.com/
        
Keywords: atlassian jira core software confluence bitbucket bamboo crowd portfolio tempo servicedesk rest api
Platform: Platform Independent
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Provides-Extra: kerberos
