Skip to main content

DocPack efficiently consolidates documentation from GitHub, Confluence, and files into a structured knowledge base for AI access.

Project description

Documentation Status https://github.com/MacHu-GWU/docpack-project/actions/workflows/main.yml/badge.svg https://codecov.io/gh/MacHu-GWU/docpack-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/docpack.svg https://img.shields.io/pypi/l/docpack.svg https://img.shields.io/pypi/pyversions/docpack.svg https://img.shields.io/badge/Release_History!--None.svg?style=social https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
https://img.shields.io/badge/Link-Document-blue.svg https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to docpack Documentation

https://docpack.readthedocs.io/en/latest/_static/docpack-logo.png

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 script converts the docpack GitHub repository into an all_in_one_knowledge_base.txt file. It is concatenated from all of the files in the sample_knowledge_base directory.

Install

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

$ pip install docpack

To upgrade to latest version:

$ pip install --upgrade docpack

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docpack-0.1.3.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docpack-0.1.3-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file docpack-0.1.3.tar.gz.

File metadata

  • Download URL: docpack-0.1.3.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for docpack-0.1.3.tar.gz
Algorithm Hash digest
SHA256 4f62c185247b77ccfc472fc3856b7683abffa3eff2ae35c88125d1becc093b05
MD5 ae9708883958f3364b3e051d6740459f
BLAKE2b-256 4d354723aab5284264f1d049567facaf06fa1ad59daaf2a4ea6dcc20f5c0e58c

See more details on using hashes here.

File details

Details for the file docpack-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: docpack-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for docpack-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c980ea3320231e9a41ef57da5c966fe6e162ba8f795462ea40d59bfb98830489
MD5 8c35b253e8548969e6f3ad332fc66c46
BLAKE2b-256 374a37ca9b50925835ca7f2dcb4b61e61aa1172816d59a62292dcb6434c26c9a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page