Skip to main content

adf-parse

Convert Atlassian Document Format (ADF) — the JSON format used by Jira and Confluence — into plain text / Markdown.

Zero dependencies. Supports paragraphs, headings, bullet/ordered lists (with nesting), code blocks, tables (with header detection), blockquotes, panels, expands, task lists, mentions, dates, statuses, inline cards, hard breaks, rules, and media references.

Installation

pip install adf-parse

Requires Python 3.11+.

Usage

from adf_parse import create_md_doc, parse_doc

adf = {
    "type": "doc",
    "version": 1,
    "content": [
        {"type": "heading", "attrs": {"level": 2},
         "content": [{"type": "text", "text": "Release notes"}]},
        {"type": "paragraph",
         "content": [{"type": "text", "text": "See the docs",
                      "marks": [{"type": "link", "attrs": {"href": "https://example.com"}}]}]},
    ],
}

print(create_md_doc(adf))
# ## Release notes
# See the docs (https://example.com)

To also get the extracted links and media references, use parse_doc:

result = parse_doc(adf)
result.collected_text  # list of rendered blocks
result.links           # list of (text, href) tuples
result.media_ref       # list of MediaRef(ref_type, ref)

License

MIT

Metadata

Release files for adf-parse 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adf-parse 0.1.0
File Size Uploaded Provenance Actions
adf_parse-0.1.0.tar.gz 4.3 kB Without provenance Details for adf_parse-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for adf-parse 0.1.0
File Interpreter ABI Platform Actions
adf_parse-0.1.0-py3-none-any.whl Python 3 none any Details for adf_parse-0.1.0-py3-none-any.whl

Total release size: 10.0 kB

Release files / adf_parse-0.1.0.tar.gz

Download URL adf_parse-0.1.0.tar.gz
Size 4.3 kB
Tags Source
SHA-256 checksum
How to use checksums
0af06bc1e7072da1741413c73fbdd5ece4937870ac1a689b06a28d7d37720375
BLAKE2b-256 checksum
How to use checksums
001a01a9428092901f7bfce6803c27dfef10ae4a4a1158ca7b9c0803e6e766ca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / adf_parse-0.1.0-py3-none-any.whl

Download URL adf_parse-0.1.0-py3-none-any.whl
Size 5.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
eb2065c179be0a9195364a50c32821df20367a77acb75b5068fcc941a14eb35a
BLAKE2b-256 checksum
How to use checksums
d1a9dc7577167ea3729eb2fcf1f2cb7fa193bb71e3fea8ed5f72adaea6e5bde5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for adf-parse 0.1.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A 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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page