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.6.tar.gz (17.7 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.6-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: docpack-0.1.6.tar.gz
  • Upload date:
  • Size: 17.7 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.6.tar.gz
Algorithm Hash digest
SHA256 7c2da0317dd7e12f704a1ec3cbd653ab3957ca7fe74cd38f26207e2715bb0dd9
MD5 fb81e2acb1a6405630c76984ad13eb5b
BLAKE2b-256 3b6c91f6b97d101a4defe411bf731371970f91a660563d0ebf2183842f5a102c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: docpack-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 19.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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a71c8a5570388f19893e4b4e5a4402b0e3e2eb8186a2e3a27de4b3642cfbb248
MD5 55d683a0340d5856a4b05e5d989f79b6
BLAKE2b-256 2b2d4859210e29948f69af7c14d37544699ef3e0be82946315c0a93ad43fa7e2

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