Metadata-Version: 1.2
Name: confluence-rest-library
Version: 0.12.4
Summary: A simple wrapper around the Confluence REST API.
Home-page: https://github.com/DaveTCode/confluence-python-lib
Author: David Tyler
Author-email: davet.code@gmail.com
License: UNKNOWN
Description: |Build Status| |PyPI version| |codecov| |Requirements Status| |Docs|
        
        Confluence Python Library
        =========================
        
        This is a simple wrapper around the REST API which the Confluence
        provides.
        
        Note that the library is undergoing major work so don’t expect the API
        to be stable until this notice is removed!
        
        c.f. `endpoints.md`_ for a list of endpoints and whether this library
        supports them yet. Please do send pull requests if you want an endpoint
        that isn’t covered!
        
        Installation
        ------------
        
        ::
        
            pip install confluence-rest-library
        
        Usage
        -----
        
        .. code:: python
        
            from confluence.client import Confluence
            with Confluence('https://site:8080/confluence', ('user', 'pass')) as c:
                pages = c.search('ID=1')
        
        Development and Deployment
        --------------------------
        
        See the `Contribution guidelines for this project`_ for details on how
        to make changes to this library.
        
        Testing Locally
        ~~~~~~~~~~~~~~~
        
        There are two sets of tests included. A suite of unit tests that verify the
        models can be built correctly and a suite of integration tests that run against
        a local instance of confluence. The unit tests can be run by simply invoking:
        .. code::
        
            python setup.py test --addopts "tests"
        
        The integration tests are more complex and require the developer to take the following steps:
        
        - Install the `Atlassian SDK <https://developer.atlassian.com/server/framework/atlassian-sdk/set-up-the-atlassian-plugin-sdk-and-build-a-project/>`_
        - Run ``atlas-run-standalone --product confluence --version 6.6.0 --server localhost``
        - Wait for the server to complete starting up
        - Run integration tests using ``python setup.py test --addopts "integration_tests"``
        
        .. _endpoints.md: endpoints.md
        .. _Contribution guidelines for this project: CONTRIBUTING.md
        
        .. |Build Status| image:: https://travis-ci.org/DaveTCode/confluence-python-lib.svg?branch=master
           :target: https://travis-ci.org/DaveTCode/confluence-python-lib
           :alt: Build status
        .. |PyPI version| image:: https://badge.fury.io/py/confluence-rest-library.svg
           :target: https://badge.fury.io/py/confluence-rest-library
           :alt: PyPI version
        .. |codecov| image:: https://codecov.io/gh/DaveTCode/confluence-python-lib/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/DaveTCode/confluence-python-lib
           :alt: Code coverage stats
        .. |Requirements Status| image:: https://requires.io/github/DaveTCode/confluence-python-lib/requirements.svg?branch=develop
           :target: https://requires.io/github/DaveTCode/confluence-python-lib/requirements/?branch=develop
           :alt: Requirements status
        .. |Docs| image:: https://readthedocs.org/projects/confluence-python-lib/badge/?version=latest
           :target: http://confluence-python-lib.readthedocs.io/en/latest/?badge=latest
           :alt: Documentation status
Keywords: confluence
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=2.7,!=3.0,!=3.1,!=3.2,!=3.3,!=3.4
