Skip to main content

A Confluence API client.

Project description

haip.config

License Build Status

haip.confluence is a simple module to communicate with confluence REST API.

Features

  • getBody: get confluence page by id
  • setBody: set confluence page content by id
  • getChildren: get children of a page --> (version, title, body)

Getting Started

Installing

pip install haip-confluence

or from source:

git clone https://github.com/haipdev/confluence.git

Example

config-files

/path-to-my-config-dir/confluence.yml

confluence:
    url: https://myconfluence.domain.com/rest/api/latest
    username: user
    password: pass
    timeout: 10

python implementation

import haip.config as config
import haip.confluence as confluence

config.load('/path-to-my-config-dir', 'dev')
content = await confluence.getBody(12345)
page = await confluence.setBody(12345, 'hello world')
children = await confluence.getChildren(12344)

Running the tests

Tests are written using pytest and located in the "tests" directory.

pytest tests

Contributing

Feel free to use and enhance this project. Pull requests are welcome.

Authors

  • Reinhard Hainz - Initial work - haipdev

License

This project is licensed under the MIT License - see the LICENSE file for details

Dependencies

Project details


Download files

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

Files for haip-confluence, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size haip_confluence-0.1.1-py3-none-any.whl (4.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size haip-confluence-0.1.1.tar.gz (2.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page