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. 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


Download files

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

Source Distribution

confluence-rest-library-1.2.2.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

confluence_rest_library-1.2.2-py2.py3-none-any.whl (40.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file confluence-rest-library-1.2.2.tar.gz.

File metadata

  • Download URL: confluence-rest-library-1.2.2.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.3

File hashes

Hashes for confluence-rest-library-1.2.2.tar.gz
Algorithm Hash digest
SHA256 1d50646de74aecdc46537ef0774f612436849c9fe55a7e4e7e4b4f95ec46dcb9
MD5 e5934f1fa27bacb1b7345a09bdeb3ea7
BLAKE2b-256 58b9b6b404fb25ed7b21a328dd1e0f8bebfc87c3d8373a50934789209708bf9f

See more details on using hashes here.

File details

Details for the file confluence_rest_library-1.2.2-py2.py3-none-any.whl.

File metadata

  • Download URL: confluence_rest_library-1.2.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 40.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.3

File hashes

Hashes for confluence_rest_library-1.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1f4495af287398b9abbb6aaad2667221d8dac3b5048a078d0aa702b16b6ab4a5
MD5 ada87277a02599af8158a7ac38227f9c
BLAKE2b-256 43651d6fb6cb97ab99740b7fb15f8c795b9146edef95a663c17d9a65976471d4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page