atlas-doc-parser 1.0.1
Atlassian Document Format Parser.
License: MIT
Requires Python: <4.0,>=3.10


.. image:: https://readthedocs.org/projects/atlas-doc-parser/badge/?version=latest
    :target: https://atlas-doc-parser.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/atlas_doc_parser-project/actions/workflows/main.yml/badge.svg
    :target: https://github.com/MacHu-GWU/atlas_doc_parser-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/atlas_doc_parser-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/atlas_doc_parser-project

.. image:: https://img.shields.io/pypi/v/atlas-doc-parser.svg
    :target: https://pypi.python.org/pypi/atlas-doc-parser

.. image:: https://img.shields.io/pypi/l/atlas-doc-parser.svg
    :target: https://pypi.python.org/pypi/atlas-doc-parser

.. image:: https://img.shields.io/pypi/pyversions/atlas-doc-parser.svg
    :target: https://pypi.python.org/pypi/atlas-doc-parser

.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/atlas_doc_parser-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/atlas_doc_parser-project

------

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://atlas-doc-parser.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/atlas_doc_parser-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/atlas_doc_parser-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/atlas_doc_parser-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/atlas-doc-parser#files


Welcome to ``atlas_doc_parser`` Documentation
==============================================================================
.. image:: https://atlas-doc-parser.readthedocs.io/en/latest/_static/atlas_doc_parser-logo.png
    :target: https://atlas-doc-parser.readthedocs.io/en/latest/

**Turn your Confluence pages and Jira issues into AI-ready Markdown.**

Confluence and Jira store rich text as `Atlassian Document Format (ADF) <https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/>`_ - a complex JSON structure that LLMs can't directly consume. This library solves that:

.. code-block:: python

    from atlas_doc_parser.api import NodeDoc

    # Parse ADF JSON from Confluence/Jira API
    doc = NodeDoc.from_dict(adf_json)

    # Convert to clean Markdown
    markdown = doc.to_markdown()

    # Feed to your AI
    response = llm.chat(f"Summarize this: {markdown}")

Now your team's knowledge in Confluence and Jira becomes training data, context, or input for any AI workflow.


.. _install:

Install
------------------------------------------------------------------------------

``atlas_doc_parser`` is released on PyPI, so all you need is to:

.. code-block:: console

    $ pip install atlas-doc-parser

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade atlas-doc-parser