Skip to main content

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"

Metadata

Release files for confluence-rest-library 1.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for confluence-rest-library 1.2.2
File Size Uploaded Provenance Actions
confluence-rest-library-1.2.2.tar.gz 26.7 kB Without provenance Details for confluence-rest-library-1.2.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for confluence-rest-library 1.2.2
File Interpreter ABI Platform Actions
confluence_rest_library-1.2.2-py2.py3-none-any.whl Python 3, Python 2 none any Details for confluence_rest_library-1.2.2-py2.py3-none-any.whl

Total release size: 66.8 kB

Release files / confluence-rest-library-1.2.2.tar.gz

Download URL confluence-rest-library-1.2.2.tar.gz
Size 26.7 kB
Tags Source
SHA-256 checksum
How to use checksums
1d50646de74aecdc46537ef0774f612436849c9fe55a7e4e7e4b4f95ec46dcb9
BLAKE2b-256 checksum
How to use checksums
58b9b6b404fb25ed7b21a328dd1e0f8bebfc87c3d8373a50934789209708bf9f
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / confluence_rest_library-1.2.2-py2.py3-none-any.whl

Download URL confluence_rest_library-1.2.2-py2.py3-none-any.whl
Size 40.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
1f4495af287398b9abbb6aaad2667221d8dac3b5048a078d0aa702b16b6ab4a5
BLAKE2b-256 checksum
How to use checksums
43651d6fb6cb97ab99740b7fb15f8c795b9146edef95a663c17d9a65976471d4
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for confluence-rest-library 1.2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page