https://github.com/davetcode/confluence-python-lib
A python library wrapping the Confluence REST API
https://github.com/davetcode/confluence-python-lib
confluence python rest rest-api
Last synced: about 1 month ago
JSON representation
A python library wrapping the Confluence REST API
- Host: GitHub
- URL: https://github.com/davetcode/confluence-python-lib
- Owner: DaveTCode
- License: mit
- Created: 2018-01-15T16:39:20.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T19:52:05.000Z (about 2 years ago)
- Last Synced: 2025-08-13T04:48:37.409Z (8 months ago)
- Topics: confluence, python, rest, rest-api
- Language: Python
- Size: 259 KB
- Stars: 41
- Watchers: 8
- Forks: 19
- Open Issues: 8
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
|Build Status| |PyPI version| |codecov| |Requirements Status| |Docs|
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
-----
.. code:: python
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"``
.. _endpoints.md: endpoints.md
.. _Contribution guidelines for this project: CONTRIBUTING.rst
.. |Build Status| image:: https://travis-ci.org/DaveTCode/confluence-python-lib.svg?branch=master
:target: https://travis-ci.org/DaveTCode/confluence-python-lib
:alt: Build status
.. |PyPI version| image:: https://badge.fury.io/py/confluence-rest-library.svg
:target: https://badge.fury.io/py/confluence-rest-library
:alt: PyPI version
.. |codecov| image:: https://codecov.io/gh/DaveTCode/confluence-python-lib/branch/master/graph/badge.svg
:target: https://codecov.io/gh/DaveTCode/confluence-python-lib
:alt: Code coverage stats
.. |Requirements Status| image:: https://requires.io/github/DaveTCode/confluence-python-lib/requirements.svg?branch=master
:target: https://requires.io/github/DaveTCode/confluence-python-lib/requirements/?branch=master
:alt: Requirements status
.. |Docs| image:: https://readthedocs.org/projects/confluence-python-lib/badge/?version=latest
:target: http://confluence-python-lib.readthedocs.io/en/latest/?badge=latest
:alt: Documentation status