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.

Source Distribution

haip-confluence-0.1.1.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

haip_confluence-0.1.1-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file haip-confluence-0.1.1.tar.gz.

File metadata

  • Download URL: haip-confluence-0.1.1.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.1 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.7.2

File hashes

Hashes for haip-confluence-0.1.1.tar.gz
Algorithm Hash digest
SHA256 293e321891cd2c847779afa090ae7269818ebe9821448000a9b0f0170a1561e4
MD5 46fc1d8ed3a87421f81429f541d14967
BLAKE2b-256 88e875db62d39e9ab537983a7e18fa1e3367ac703c5799c886df9fddf35ad5a5

See more details on using hashes here.

File details

Details for the file haip_confluence-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: haip_confluence-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.1 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.7.2

File hashes

Hashes for haip_confluence-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a77fd1526bdb79032804b82229cba8b26c84c847dc117aa20114469540ab7f60
MD5 17e5599b7e1d7e5f12f4631b3fd0518a
BLAKE2b-256 b4865144e59fecd0dd6135ed2a27d4708067e4128c12c6a44c44d4ac87c0f2ca

See more details on using hashes here.

Supported by

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