Skip to main content

Pack an entire project into a single markdown bundle for documentation, sharing, or LLM ingestion.

Project description

repopack

repopack is a small Python library that packs an entire project into a single markdown file. It walks the project tree, skips common build and virtualenv folders, and writes each included source file into a readable markdown bundle.

Installation

Install locally from this folder

pip install -e .

Install from GitHub

git clone https://github.com/Nishanbhattarai498/RepoPack.git
cd RepoPack
pip install -e .

Make it available to others

To make it available on PyPI so other people can install it with pip install repopack, you need to:

  1. Create an account on https://pypi.org/
  2. Install build tools:
    python -m pip install --upgrade build twine
    
  3. Build the package:
    python -m build
    
  4. Upload it:
    python -m twine upload dist/*
    

After that, others can install it with:

pip install repopack

Usage

from repopack import pack_project_to_markdown

pack_project_to_markdown("./my-project", "./bundle.md")

What it produces

The generated markdown file contains:

  • a title section
  • one section per included file
  • the file path as a heading
  • the file contents inside fenced code blocks

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

repopack_tool-0.1.0.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

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

repopack_tool-0.1.0-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file repopack_tool-0.1.0.tar.gz.

File metadata

  • Download URL: repopack_tool-0.1.0.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for repopack_tool-0.1.0.tar.gz
Algorithm Hash digest
SHA256 32968dbe0f5155a8e879fba9d4e8751b909a33750891a79a079ffedc1f33faf1
MD5 6fbb97da18e4ded628983527227fbf43
BLAKE2b-256 0777528df07f4e76b893ac25f6914082f17809184946267fd0251067e7ceb558

See more details on using hashes here.

File details

Details for the file repopack_tool-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: repopack_tool-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for repopack_tool-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ab793bb2b259e51e3059e96da8d85b8a8aaea951ca8eafd0d936df3a1ab0ade5
MD5 e14cc37ae777f2b9ff0e663ac4e3f8da
BLAKE2b-256 1178cdcb0a866e2adaec575223329c827ababbd75ecac31e0327bdaaf78adb22

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