Metadata-Version: 2.0
Name: confluence-rest-library
Version: 0.6.1
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-Content-Type: UNKNOWN
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
Requires-Dist: requests (<3.0.0a0,>=2.18.4)

|Build Status| |PyPI version|

Confluence Python Library
=========================

This is a simple wrapper around the REST API which the Confluence
provides.

c.f. `endpoints.md <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 <CONTRIBUTING.md>`__
for details on how to make changes to this library.

Testing Locally
~~~~~~~~~~~~~~~

For now there are only some basic unit tests included. These can be run
using

::

    python setup.py test

.. |Build Status| image:: https://travis-ci.org/DaveTCode/confluence-python-lib.svg?branch=master
   :target: https://travis-ci.org/DaveTCode/confluence-python-lib
.. |PyPI version| image:: https://badge.fury.io/py/confluence-rest-library.svg
   :target: https://badge.fury.io/py/confluence-rest-library


