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.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c47e912a2019e80472d4c6a5f322bb6339bb86a1e728fca69546528726a0207c |
|
MD5 | 7a424c53199e1fb03a80f6203d7e7363 |
|
BLAKE2b-256 | ee4fe7a7213aa813030627221546bf0c2882edbd2250a2a830d1e316a48d7ae8 |
Hashes for confluence_rest_library-1.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdeff8589f8038d392b0ecdc8a6a9d72805e20da1a898529eeef7eb071d56c24 |
|
MD5 | bb490464fc84aad79120f1af6c2ed800 |
|
BLAKE2b-256 | 34c24885be797d0ca38d2caf927211826754918a431971ae542b6a185c56d05e |