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.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2390c9c6dd6c023f3ed3b60fd4d9e1fcab25091ec6e02976a55d656d4abeaf77 |
|
MD5 | 7db97780eeccbf692a25357f4c656e65 |
|
BLAKE2b-256 | 5e3618447d176547ee2c629662ab828a067b70a70964d9dc0ea45da4b3b0aa62 |
Hashes for confluence_rest_library-1.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57cd927b7202bee47cd306b55828a99970ce61e3db876f7b24be77fca6172fc4 |
|
MD5 | b838843be543d87ac1dd35898d007b6b |
|
BLAKE2b-256 | 57bfb5b00079243cdc7a30a2efe223699e0afba1b54b8006e6a60de3b2b2b989 |