A simple wrapper around the Confluence REST API.
Project description
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. 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
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
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"
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for confluence-rest-library-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbd5ee4f771d31229bc89ff0e1d2fdaa013d43fea98573a3c809c7cd8c2500df |
|
MD5 | e74c1418cd56733b22e32f46dde30d96 |
|
BLAKE2b-256 | b1e5d9076b67455f21b305544b49fa42a78387e6dd4aa3d59d4916ed07762d77 |
Hashes for confluence_rest_library-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6708132ad80d43c7922fd4eb4fa536449e2cc7cb9217368d0c6c1a475dc6f54a |
|
MD5 | e04d7df6d57adf6532f1e7f97bc7c2fd |
|
BLAKE2b-256 | ead34730ee353253acc72beb98b4abdec09503d7903ed76e36ba16336bd3ca65 |