{"id":8841,"library":"atlassian-doc-builder","title":"Atlassian Document Builder","description":"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.","status":"active","version":"0.5.2","language":"python","source_language":"en","source_url":"https://github.com/khwong-c/atlassian-doc-builder","tags":["atlassian","confluence","jira","adf","document-generation","document-builder","automation"],"install":[{"cmd":"pip install atlassian-doc-builder","lang":"bash","label":"Install stable version"}],"dependencies":[],"imports":[{"wrong":"from atlassian_doc_builder import ADFDocument","symbol":"ADFDoc","correct":"from atlassian_doc_builder import ADFDoc"},{"symbol":"ADFParagraph","correct":"from atlassian_doc_builder import ADFParagraph"},{"symbol":"ADFHeading","correct":"from atlassian_doc_builder import ADFHeading"}],"quickstart":{"code":"from atlassian_doc_builder import ADFDocument, ADFParagraph, ADFText, ADFLink\n\n# Create a new Atlassian Document\ndoc = ADFDocument()\n\n# Add a paragraph with plain text\ndoc.add_node(ADFParagraph().add_node(ADFText(\"Hello, Atlassian Document Builder!\")))\n\n# Add another paragraph with text and a link\nparagraph_with_link = ADFParagraph()\nparagraph_with_link.add_node(ADFText(\"Visit the \"))\nparagraph_with_link.add_node(ADFLink(text=\"official GitHub repository\", href=\"https://github.com/khwong-c/atlassian-doc-builder\"))\nparagraph_with_link.add_node(ADFText(\" for more examples.\"))\ndoc.add_node(paragraph_with_link)\n\n# Print the generated ADF JSON (for demonstration, in a real app you might save or upload this)\nprint(doc.dumps(indent=2))","lang":"python","description":"This quickstart demonstrates how to create a basic Atlassian Document (ADF) with paragraphs, text, and a link, then outputs its JSON representation."},"warnings":[{"fix":"Ensure your environment fetches the latest schema or update any hardcoded schema references if you're performing external schema validation.","message":"Version 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.","severity":"breaking","affected_versions":">=0.5.2"},{"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.","message":"The 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.","severity":"gotcha","affected_versions":"All"},{"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.","message":"Version 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.","severity":"gotcha","affected_versions":">=0.4"}],"env_vars":null,"search_vec":"'0.5.2':13 'activ':58 'adf':22,48,67 'atlassian':1,6,20,64 'atlassian-doc-build':5 'autom':33,74 'builder':3,8,73 'cadenc':60 'confluenc':26,65 'content':39 'creat':19 'current':10 'develop':31 'doc':7 'document':2,21,45,52,69,72 'document-build':71 'document-gener':68 'enabl':30 'generat':37,70 'jira':28,66 'json':47 'librari':9 'like':25,44 'maintain':56 'pars':50 'platform':24 'programmat':16 'project':55 'provid':14 'public':35 'regular':62 'releas':59 'render':49 'report':34 'represent':46 'structur':38 'support':40 'tree':43 'tree-lik':42 'updat':63 'valid':53 'version':12 'way':17","created_at":"2026-04-16T18:47:07.472351+00:00","updated_at":"2026-04-16T18:47:07.472351+00:00","problems":null,"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":"0.5.2","cli_name":"","cli_version":null,"type":"library","homepage":null,"github":"https://github.com/khwong-c/atlassian-doc-builder","docs":null,"changelog":null,"pypi":"https://pypi.org/project/atlassian-doc-builder/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["crm-productivity","serialization"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"passing","verified_at":"2026-06-30","last_verified":"2026-06-30","next_check":"2026-07-30","install_tag":null}}