Skip to main content

A simple wrapper around the Confluence REST API.

Project description

Build status PyPI version Code coverage stats Requirements status Documentation status

Confluence Python Library

This is a simple wrapper around the REST API which the Confluence provides. Consider the API to be stable as of v1.0.0 (now released)

c.f. 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!


pip install confluence-rest-library


from confluence.client import Confluence
with Confluence('https://site:8080/confluence', ('user', 'pass')) as c:
    pages ='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 test --addopts "tests"

The integration tests are more complex and require the developer to take the following steps:

  • Install the Atlassian SDK
  • 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 test --addopts "integration_tests"

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for confluence-rest-library, version 1.2.2
Filename, size File type Python version Upload date Hashes
Filename, size confluence_rest_library-1.2.2-py2.py3-none-any.whl (40.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size confluence-rest-library-1.2.2.tar.gz (26.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page