Skip to main content

Confluence REST API client for Python

Project description

PyFluence


A Python 2 and 3 REST API client for Atlassian Confluence

This library lets you view, edit, delete entities in an instance of Atlassian Confluence using its REST API

Simple Demo

from pyfluence import Confluence

# First create a Confluence instance:
confluence = Confluence("admin","admin","http://localhost:1990/confluence")

# Then create a space
space_ob = confluence.create_space("TEST","Test Space","Test Space Description")

# Then create a page in that space
content_ob = confluence.create_content(
    space_key=space_ob['key'],
    content_type="page",
    title="Test Parent Page",
    html_markup="<h1>This is a test page</h1>",
)

# Then you can update the page
confluence.update_content(
    space_key=space_ob['key'],
    page_id=content_ob['id'],
    html_markup="<h1>This is an update</h1>",
    update_type=co.UPDATE_REPLACE
)

Developing

You can use the Atlassian Developer SDK to run tests. You can follow the instructions here:
https://developer.atlassian.com/server/framework/atlassian-sdk/downloads/

On the mac, for example:

> brew tap atlassian/tap
> brew install atlassian/atlas-tap/atlassian-plugin-sdk # or upgrade
> atlas-run-standalone --product confluence
> python -m unittest pyfluence/tests/test_confluence.py

View confluence here:

http://localhost:1990/confluence

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

pyfluence-0.2.1.tar.gz (11.4 kB view details)

Uploaded Source

File details

Details for the file pyfluence-0.2.1.tar.gz.

File metadata

  • Download URL: pyfluence-0.2.1.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.5

File hashes

Hashes for pyfluence-0.2.1.tar.gz
Algorithm Hash digest
SHA256 409bc381c943b75d6f71c81e9d59bd1f1d5f2b87f90b81d94ce6c61d24a57b63
MD5 e6bcb1cd05d4e28f5eecd0d2f39d79c4
BLAKE2b-256 ecdf49333e4aa5b4161e9c1b3c79026aa7f1f4b824fab7da7a3352ea15543113

See more details on using hashes here.

Supported by

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