atlassian-doc-builder

What it is and what it does

Atlassian Document Builder lets you create Atlassian Document Format (ADF) documents programmatically instead of through the UI. It provides a tree-like object model that maps to ADF's JSON structure, so you can build documents in Python code, validate them against the schema, and render them as JSON ready for Confluence or Jira APIs. The package includes support for common elements like text, paragraphs, tables, links, lists, and collapsible sections, with a template system for reusable document patterns.

Typical use is automating report generation and publication into Confluence or Jira as part of CI/CD pipelines—for example, publishing functional verification reports or requirement documents directly from test runs or build systems. The package depends only on jsonschema for validation, making it lightweight to integrate into existing workflows.

Use it for:

• Automate generation of test reports and publish them to Confluence from CI/CD pipelines
• Programmatically create requirement or specification documents in Jira from source data
• Build reusable document templates with variable substitution for recurring report formats
• Generate tables and structured data exports from Python scripts into Atlassian documents
• Validate ADF document structure before sending to Confluence or Jira APIs

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Programmatically generate and validate Atlassian Document Format (ADF) documents for Confluence and Jira, with tree-like representation, JSON rendering, templating, and variable substitution.

Yes, if you need to automate Atlassian document creation from Python. The package is actively maintained, has low install friction, carries a permissive MIT license, and solves a specific problem with minimal dependencies. It is in Beta, so expect some API surface to evolve, but the core functionality is stable enough for production use in CI/CD automation.

Install

atlassian-doc-builder on PyPI

pip install atlassian-doc-builder

uv add atlassian-doc-builder

poetry add atlassian-doc-builder

Installing atlassian-doc-builder

Before you install

Low friction install with a single runtime dependency (jsonschema). Repository is active with recent commits and no archived status, though the project is in Beta development stage.

License in practice

MIT License permits free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.

Quickstart

pip install atlassian-doc-builder

from atlassian_doc_builder import ADFDocument, ADFParagraph, ADFText

doc = ADFDocument()
para = ADFParagraph()
para.append(ADFText('Hello, Confluence'))
doc.append(para)
json_output = doc.render()

Requires Python 3.8 or later.

Verify before relying

• Whether the package supports all ADF node types or only a subset of the Atlassian specification
• Performance characteristics when generating large or deeply nested documents
• Compatibility with specific Confluence and Jira server/cloud versions

Package facts

Evidence: atlassian_doc_builder-0.6.0-py3-none-any.whl

Tags

More Documentation packages