conflupy

A Python library for Atlassian Confluence REST API

Version with 1.0.x ~ 1.2.x are for distribution tests and have bugs. Please use conflupy >= 1.3.0

Requirements

• Python >= 3.9
• Atlassian Confluence (REST API docs)
  • This library is tested in Atlassian Confluence 7.19.0
  • Confluence REST API examples
  • Confluence Storage Format

Installation

pip install conflupy

Usage

from confluence import Confluence

# Initialize Confluence
confluence = Confluence(base_url: 'https://confluence.example.com', account: (USER_ID, USER_PW))

# Get Pages
pages = confluence.get_pages(space_key='TEST')
print('Pages :', pages)

# Get Specific Page
page = confluence.get_content(content_id='1349141')
print('Page :', page)

# Create a new Page
body = '<h1>Hello</h1><br /><p>This is a page created with REST API</p>'
new_page = create_page(space_key='TEST', title='Test Page', body=body)
print('New Page :', new_page)

Build & Deploy (PyPi)

# Build
pip install build
python -m build
# whl file & archived src(tar.gz) file will be generated.

# Deploy
pip install twine
python -m twine upload dist/*
# package will be uploaded to PyPi registry
# https://pypi.org/project/conflupy

However, this project use GitHub Actions workflow to automatically publish the package to PyPI when a tag pushed.

To Do

• Unittest

Authors

• Daeyeol Ryu

License

• Apache License 2.0