ADF Library
ADF Library is a Python package for creating and exporting Atlassian Document Format (ADF) content for Jira, Confluence, and other Atlassian Cloud products.
Overview
The library provides:
- high-level helpers for headings, paragraphs, tables, and links
- generic
NodeandMarkbuilders for the latest published ADF node and mark types - plain Python dictionaries that can be sent directly to Atlassian APIs
Installation
pip install adf_lib
Quick Start
from adf_lib import ADF, Link, Mark, Node, NodeType, Table, Text
from adf_lib.constants.enums import HeadingLevel
doc = ADF()
doc.add(Text("My Document").heading(HeadingLevel.H1))
doc.add(Text("This is a formatted paragraph", "strong", "em").paragraph())
link = Link(href="https://example.com", title="Example")
doc.add(Text("Open example", link.to_mark()).paragraph())
doc.add(
Node(
NodeType.PANEL,
attrs={"panelType": "info"},
content=[Text("This uses a latest-schema node").paragraph()],
)
)
doc.add(
Node(
NodeType.PARAGRAPH,
content=[
Node(
NodeType.TEXT,
text="Highlighted text",
marks=[Mark("backgroundColor", {"color": "#FFF0B3"})],
)
],
)
)
adf_dict = doc.to_dict()
Latest ADF Node Coverage
Use Text, Table, and Link for common authoring flows. Use Node, NodeType, and Mark for newer ADF structures such as:
- lists:
bulletList,orderedList,listItem - rich blocks:
codeBlock,panel,blockquote,rule,expand,nestedExpand - smart content:
inlineCard,blockCard,embedCard,status,date,mention,emoji - layout and media:
layoutSection,layoutColumn,media,mediaGroup,mediaSingle
This keeps the public API small while allowing the library to emit the latest published ADF node names.
API Summary
Core helpers
ADF: document containerText: heading and paragraph helperTable: table helperLink: link mark helper
Generic schema helpers
Node: generic ADF node builderNodeType: enum of latest published node namesMark: generic ADF mark builderMarkType: enum of latest published mark names
Documentation
Project documentation is available in /docs and published at:
References
Metadata
Release files for adf-lib 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| adf_lib-0.3.1.tar.gz | 13.6 kB | With provenance | Details for adf_lib-0.3.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| adf_lib-0.3.1-py3-none-any.whl | Python 3 | none | any | Details for adf_lib-0.3.1-py3-none-any.whl |
Total release size: 25.5 kB
Release files / adf_lib-0.3.1.tar.gz
| Download URL | adf_lib-0.3.1.tar.gz |
|---|---|
| Size | 13.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e2232735ee7eb68b4531e892a850eaefd29c52afc0f5e7479b06f7b394198f59
|
|
BLAKE2b-256 checksum How to use checksums |
4d771d806eccf3b5bf6d72895e97ef985647656888e4ff8f6210f3abeeb054cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 4, 2026.
Transparency logRelease files / adf_lib-0.3.1-py3-none-any.whl
| Download URL | adf_lib-0.3.1-py3-none-any.whl |
|---|---|
| Size | 11.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6d65ddb3a837321fc6f21ddb9c52683110892c747132f9cb3f59b62edde2554e
|
|
BLAKE2b-256 checksum How to use checksums |
70bf54e0cbbf8fb64dfcdbee61bb3d0727bd5d5b072b54a5dda9e6fe9afaa702
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 4, 2026.
Transparency logSecurity for adf-lib 0.3.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for adf_lib-0.3.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 4, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.