Metadata-Version: 2.2
Name: docpack
Version: 0.1.1
Summary: DocPack efficiently consolidates documentation from GitHub, Confluence, and files into a structured knowledge base for AI access.
Home-page: https://github.com/MacHu-GWU/docpack-project
Download-URL: https://pypi.python.org/pypi/docpack/0.1.1#downloads
Author: Sanhe Hu
Author-email: husanhe@gmail.com
Maintainer: Sanhe Hu
Maintainer-email: husanhe@email.com
License: MIT
Platform: Windows
Platform: MacOS
Platform: Unix
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
License-File: LICENSE.txt
License-File: AUTHORS.rst
Requires-Dist: pyatlassian<1.0.0,>=0.3.1
Requires-Dist: atlas_doc_parser<1.0.0,>=0.1.2
Requires-Dist: pydantic<3.0.0,>=2.9.2
Requires-Dist: diskcache<6.0.0,>=5.6.3
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Provides-Extra: docs
Requires-Dist: Sphinx==5.3.0; extra == "docs"
Requires-Dist: sphinx-jinja==2.0.2; extra == "docs"
Requires-Dist: sphinx-copybutton==0.5.1; extra == "docs"
Requires-Dist: sphinx-design==0.5.0; extra == "docs"
Requires-Dist: furo==2023.03.27; extra == "docs"
Requires-Dist: nbsphinx==0.8.12; extra == "docs"
Requires-Dist: rstobj==1.2.1; extra == "docs"
Requires-Dist: pygments==2.15.1; extra == "docs"
Requires-Dist: ipython==8.10.0; extra == "docs"
Requires-Dist: docfly==2.0.3; extra == "docs"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: download-url
Dynamic: home-page
Dynamic: license
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: platform
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary


.. image:: https://readthedocs.org/projects/docpack/badge/?version=latest
    :target: https://docpack.readthedocs.io/en/latest/
    :alt: Documentation Status

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

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

.. image:: https://img.shields.io/pypi/v/docpack.svg
    :target: https://pypi.python.org/pypi/docpack

.. image:: https://img.shields.io/pypi/l/docpack.svg
    :target: https://pypi.python.org/pypi/docpack

.. image:: https://img.shields.io/pypi/pyversions/docpack.svg
    :target: https://pypi.python.org/pypi/docpack

.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
    :target: https://github.com/MacHu-GWU/docpack-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
    :target: https://github.com/MacHu-GWU/docpack-project

------

.. image:: https://img.shields.io/badge/Link-Document-blue.svg
    :target: https://docpack.readthedocs.io/en/latest/

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://docpack.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/docpack-project

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

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

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


Welcome to ``docpack`` Documentation
==============================================================================
.. image:: https://docpack.readthedocs.io/en/latest/_static/docpack-logo.png
    :target: https://docpack.readthedocs.io/en/latest/

DocPack is a Python utility library designed to efficiently consolidate documentation from multiple sources (GitHub, Confluence, and local file systems) into a single, AI-accessible knowledge base. It provides tools for retrieving, formatting, and packaging document content with consistent structure to facilitate efficient reference by Large Language Models.


.. _install:

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

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

.. code-block:: console

    $ pip install docpack

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade docpack
