Registry / crm-productivity / atlassian-doc-builder

atlassian-doc-builder

library0.5.2pypypi✓ verified 82d ago

The `atlassian-doc-builder` library, currently at version 0.5.2, provides a programmatic way to create Atlassian Documents (ADF) for platforms like Confluence and Jira. It enables developers to automate report publication and generate structured content, supporting a tree-like document representation, JSON ADF rendering, parsing, and document validation. The project maintains an active release cadence with regular updates.

crm-productivity serialization

pip install atlassian-doc-builder

github ↗package ↗

INSTALL

IMPORT

SIG · ATLASSIAN-DOC-BUIL

atlassian-doc-builder

crm-productivitypythonv0.5.2

Install

2.4s avg

Import

—

Disk

20MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.5.2 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.920 runs

installs and imports cleanly · install 0.0s · import 0.000s · 21.6MB

glibc

py 3.10–3.920 runs

installs and imports cleanly · install 2.4s · import 0.000s · 22MB

20MB installed

● package 20MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ADFDoc

✓ from atlassian_doc_builder import ADFDoc

✗ from atlassian_doc_builder import ADFDocument

ADFParagraph

✓ from atlassian_doc_builder import ADFParagraph

ADFHeading

✓ from atlassian_doc_builder import ADFHeading

This quickstart demonstrates how to create a basic Atlassian Document (ADF) with paragraphs, text, and a link, then outputs its JSON representation.

from atlassian_doc_builder import ADFDocument, ADFParagraph, ADFText, ADFLink # Create a new Atlassian Document doc = ADFDocument() # Add a paragraph with plain text doc.add_node(ADFParagraph().add_node(ADFText("Hello, Atlassian Document Builder!"))) # Add another paragraph with text and a link paragraph_with_link = ADFParagraph() paragraph_with_link.add_node(ADFText("Visit the ")) paragraph_with_link.add_node(ADFLink(text="official GitHub repository", href="https://github.com/khwong-c/atlassian-doc-builder")) paragraph_with_link.add_node(ADFText(" for more examples.")) doc.add_node(paragraph_with_link) # Print the generated ADF JSON (for demonstration, in a real app you might save or upload this) print(doc.dumps(indent=2))

Debug

Known issues

breakingVersion 0.5.2 updated the internal `adf_schema` URL. While this is a fix, custom validation logic or direct interaction with schema URLs based on older versions might encounter issues if they relied on the previous URL.

fix

Ensure your environment fetches the latest schema or update any hardcoded schema references if you're performing external schema validation.

affects: >=0.5.2

gotchaThe library heavily relies on building a tree-like structure that strictly adheres to the Atlassian Document Format (ADF) schema. Incorrect nesting or invalid child nodes will result in malformed ADF that may fail validation or render incorrectly on Atlassian platforms.

fix

Always refer to the official Atlassian Document Format documentation and the library's examples to understand valid node hierarchies and attributes. Use `doc.dumps(indent=2)` to inspect the generated JSON and debug structure issues.

affects: All

gotchaVersion 0.4 introduced `ADFTable` objects and index-based access (e.g., `doc[1,2,3]`) for child nodes. While not directly breaking, this introduces new patterns for document manipulation.

fix

Familiarize yourself with the new table creation routines and index access methods when working with tabular data or complex document structures. Existing code for non-table elements should remain compatible.

affects: >=0.4

Upgrade

Version history

0.5.2latest on PyPI · released Dec 16, 2025

Audit

Dependencies

No dependency data recorded yet.

Agent activity

54 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/khwong-c/atlassian-doc-builder ↗

packagehttps://pypi.org/project/atlassian-doc-builder/ ↗