/confluence-python-lib

A python library wrapping the Confluence REST API

Primary LanguagePythonMIT LicenseMIT

Build Status PyPI version

Confluence Python Library

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

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

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

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

python setup.py test