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.2.tar.gz (17.5 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.2-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: docpack-0.1.2.tar.gz
  • Upload date:
  • Size: 17.5 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.2.tar.gz
Algorithm Hash digest
SHA256 6c0b1fe5e9fd7b9ec6a744e2e8703ccc0b458cccc8ade4469a35303119abf1c3
MD5 89ac9534924b865efede0f6d9f5ff76f
BLAKE2b-256 365079cbb6ad50f42e2d5e59a069a2d9fa49c7af0fbae3799a8eb12c576e8dbe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: docpack-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 20.4 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bb1d629d76c2aea0a86b7fb58865e0873b99bab1f8b361adef51ed93045868aa
MD5 d0f99789dcfb5056d8e69c8be5705a3f
BLAKE2b-256 ae8778a8aebf755e35a9f02ab4d8e05e49788bf0184b17192893e099515e66e6

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