.. 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.
For example, this `generate_knowledge_base.py <https://github.com/MacHu-GWU/docpack-project/blob/main/genai/generate_knowledge_base.py>`_ script converts the `docpack <https://github.com/MacHu-GWU/docpack-project>`_ GitHub repository into an `all_in_one_knowledge_base.txt <https://github.com/MacHu-GWU/docpack-project/blob/main/genai/sample_knowledge_base/all_in_one_knowledge_base.txt>`_ file. It is concatenated from all of the files in the `sample_knowledge_base <https://github.com/MacHu-GWU/docpack-project/tree/main/genai/sample_knowledge_base>`_ directory.
.. _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
Raw data
{
"_id": null,
"home_page": null,
"name": "docpack",
"maintainer": "Sanhe Hu",
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": "husanhe@gmail.com",
"keywords": null,
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bf/7d/9a001a2e5bfb7e9410853ed067399855157137e5df34e3b16293f65f0b61/docpack-0.1.4.tar.gz",
"platform": null,
"description": "\n.. image:: https://readthedocs.org/projects/docpack/badge/?version=latest\n :target: https://docpack.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/docpack-project/actions/workflows/main.yml/badge.svg\n :target: https://github.com/MacHu-GWU/docpack-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/docpack-project/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/docpack-project\n\n.. image:: https://img.shields.io/pypi/v/docpack.svg\n :target: https://pypi.python.org/pypi/docpack\n\n.. image:: https://img.shields.io/pypi/l/docpack.svg\n :target: https://pypi.python.org/pypi/docpack\n\n.. image:: https://img.shields.io/pypi/pyversions/docpack.svg\n :target: https://pypi.python.org/pypi/docpack\n\n.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/docpack-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/docpack-project\n\n------\n\n.. image:: https://img.shields.io/badge/Link-Document-blue.svg\n :target: https://docpack.readthedocs.io/en/latest/\n\n.. image:: https://img.shields.io/badge/Link-API-blue.svg\n :target: https://docpack.readthedocs.io/en/latest/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/docpack-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/docpack-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/docpack-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/docpack#files\n\n\nWelcome to ``docpack`` Documentation\n==============================================================================\n.. image:: https://docpack.readthedocs.io/en/latest/_static/docpack-logo.png\n :target: https://docpack.readthedocs.io/en/latest/\n\nDocPack 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.\n\nFor example, this `generate_knowledge_base.py <https://github.com/MacHu-GWU/docpack-project/blob/main/genai/generate_knowledge_base.py>`_ script converts the `docpack <https://github.com/MacHu-GWU/docpack-project>`_ GitHub repository into an `all_in_one_knowledge_base.txt <https://github.com/MacHu-GWU/docpack-project/blob/main/genai/sample_knowledge_base/all_in_one_knowledge_base.txt>`_ file. It is concatenated from all of the files in the `sample_knowledge_base <https://github.com/MacHu-GWU/docpack-project/tree/main/genai/sample_knowledge_base>`_ directory.\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``docpack`` is released on PyPI, so all you need is to:\n\n.. code-block:: console\n\n $ pip install docpack\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade docpack\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "DocPack efficiently consolidates documentation from GitHub, Confluence, and files into a structured knowledge base for AI access.",
"version": "0.1.4",
"project_urls": {
"Changelog": "https://github.com/MacHu-GWU/docpack-project/blob/main/release-history.rst",
"Documentation": "https://docpack.readthedocs.io/en/latest/",
"Download": "https://pypi.org/pypi/docpack#files",
"Homepage": "https://github.com/MacHu-GWU/docpack-project",
"Issues": "https://github.com/MacHu-GWU/docpack-project/issues",
"Repository": "https://github.com/MacHu-GWU/docpack-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e5b733ba3bdbfeed12aba2bfd38ed47a0584bb97d808594eef9da318df99be16",
"md5": "da351f365961184dca55d903da69319c",
"sha256": "278886e1ec31db7091df5a9cef340df6d641d9359498afbb52cd72f9a1940b0d"
},
"downloads": -1,
"filename": "docpack-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da351f365961184dca55d903da69319c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 19714,
"upload_time": "2025-09-16T18:24:38",
"upload_time_iso_8601": "2025-09-16T18:24:38.736274Z",
"url": "https://files.pythonhosted.org/packages/e5/b7/33ba3bdbfeed12aba2bfd38ed47a0584bb97d808594eef9da318df99be16/docpack-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "bf7d9a001a2e5bfb7e9410853ed067399855157137e5df34e3b16293f65f0b61",
"md5": "f23c9534b809715ccbfa13d083458f30",
"sha256": "23f310878c220a35b4f3ccd7a7ee1c33b8a9c7f0c7ce7f360380081759f18ee0"
},
"downloads": -1,
"filename": "docpack-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "f23c9534b809715ccbfa13d083458f30",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 17652,
"upload_time": "2025-09-16T18:24:39",
"upload_time_iso_8601": "2025-09-16T18:24:39.947455Z",
"url": "https://files.pythonhosted.org/packages/bf/7d/9a001a2e5bfb7e9410853ed067399855157137e5df34e3b16293f65f0b61/docpack-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-16 18:24:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MacHu-GWU",
"github_project": "docpack-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "annotated-types",
"specs": [
[
"==",
"0.7.0"
]
]
},
{
"name": "atlas-doc-parser",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2025.1.31"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.4.1"
]
]
},
{
"name": "diskcache",
"specs": [
[
"==",
"5.6.3"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.10"
]
]
},
{
"name": "pathpick",
"specs": [
[
"==",
"0.1.1"
]
]
},
{
"name": "pathspec",
"specs": [
[
"==",
"0.12.1"
]
]
},
{
"name": "pyatlassian",
"specs": [
[
"==",
"0.3.2"
]
]
},
{
"name": "pydantic-core",
"specs": [
[
"==",
"2.33.0"
]
]
},
{
"name": "pydantic",
"specs": [
[
"==",
"2.11.1"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
"==",
"4.13.0"
]
]
},
{
"name": "typing-inspection",
"specs": [
[
"==",
"0.4.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.3.0"
]
]
}
],
"lcname": "docpack"
}
JSON
