No project description provided
Project description
ConfluenPy
ConfluenPy is a Python package that allows you to interact with Atlassian Confluence via the REST API to programmatically create and update documentation pages content.
Example usage
# Example usage
confluence = atlassian.Confluence(
url='https://example.atlassian.net/',
username='your.user@company.com',
password=os.getenv('CONFLUENCE_API_TOKEN')
)
page = Page(title='WonderDocs', space='IsVast', confluence=confluence)
# Add a table of contents
page.body.toc()
# Add a horizontal rule
page.body.horizontal_rule()
# Takes the Readme.md file and converts it to confluence format
with open('README.md', encoding='utf-8') as markdown_text:
markdown = MarkdownToConfluenceConverter.convert(markdown_text.read())
# Only takes the second section of the markdown file
page.body.content += markdown.section(2)
# Adds some more content
page.body.heading('h1', "Biggest heading")
page.body.block_quote('This is a paragraph')
page.body.code_block(title='tt', content='Wonderful code')
# Update the page
page.update()
Installation
Simply install the package using pip:
pip install confluenpy
Usage
Confluence pages are represented by the Page
class. The page content is handled by a PageBody
object, which represents it in the confluence wiki markup.
The following confluence macros are also supported via the wiki markup (see the MacroMixin
class for details):
- toc
- code block
Markup support
The MarkdownToConfluenceConverter
class allows to convert markdown to confluence wiki markup. The following markdown elements are supported:
- headings
- code blocks
- public images
Regular markup notation is also supported (bold, italic).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for confluenpy-0.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2145a6091fe3e52412830997b08b2739b42a7d825992d9aee0dfd57f87cd5737 |
|
MD5 | f8a34e96ddc33a325741e6527b22ebe3 |
|
BLAKE2b-256 | 74dde365f251762d6bd330e9f51f226da7e18d5301bd85031f4e2b87fdd08a80 |