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, emoji, dates, statuses, inline cards, hard breaks, rules, and media references. Inline marks render as real Markdown: links [text](url), bold, italic, strikethrough, and code.
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)
For search indexes, RAG, and LLM/agent pipelines, use plain mode — it drops emoji and all Markdown decoration (**, *, ~~, backticks, [text](url)), giving clean text while links and media are still collected as data:
from adf_parse import create_text_doc
create_text_doc(adf) # clean plain text
parse_doc(adf, plain=True) # same, with .links and .media_ref
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, alt, media_type)
License
MIT
Metadata
Release files for adf-parse 0.3.0
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_parse-0.3.0.tar.gz | 5.0 kB | Without provenance | Details for adf_parse-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| adf_parse-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for adf_parse-0.3.0-py3-none-any.whl |
Total release size: 11.5 kB
Release files / adf_parse-0.3.0.tar.gz
| Download URL | adf_parse-0.3.0.tar.gz |
|---|---|
| Size | 5.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f1f0de456d9c09fc10bf750cc4819026118d6ea49776d918a50e61d11ba573ed
|
|
BLAKE2b-256 checksum How to use checksums |
ff46f7a18966a699211bbaa175bd174d60d0864bfa7c375543b4d103b6330ed8
|
| 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.3.0-py3-none-any.whl
| Download URL | adf_parse-0.3.0-py3-none-any.whl |
|---|---|
| Size | 6.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bad2307a2eda0b20ac04d23fa6c3008b6d1d180426c28724a2042f46f14d6b5d
|
|
BLAKE2b-256 checksum How to use checksums |
2b1dff1c151af06f39ac8f2a938e4212a2b762ff9eba590f098d5ddacb83078d
|
| 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.3.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.