Convert coding repositories into PDFs and JSON summaries
Project description
repo-2-pdf
Convert your repositories into clean PDFs and structured JSON outputs, designed for AI ingestion pipelines but also useful for documentation.
Features
- Convert local or remote GitHub repositories
- Generate PDFs containing full file structures and contents
- Output structured JSON summaries
- Exclude unnecessary file types automatically
Installation
Option 1: Install from PyPI (Recommended)
pip install repo2pdf
Option 2: Install from Source
Clone the repository and install locally:
git clone https://github.com/haris-sujethan/repo-2-pdf
cd repo-2-pdf
pip install -r requirements.txt
Then choose one of the following:
Local development install (recommended):
pip install -e .
repo2pdf
Run without installing:
python -m repo2pdf.cli
Usage
Run the CLI tool:
repo2pdf
Follow the interactive prompts:
- Select local or remote repository
- Provide the local repo path or GitHub URL
- Choose an output location
- Exclude any file types you don't want included (e.g.,
.png,.jpg) - Optionally generate a JSON summary alongside the PDF
Example CLI Flow
The CLI provides an interactive terminal interface that guides you through the conversion process:
Example Outputs
Example outputs are available in the /examples folder:
- repo_output.pdf - Clean PDF with full repository structure and file contents
- repo_output.json - Structured JSON summary perfect for AI ingestion
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file repo2pdf-0.1.3.tar.gz.
File metadata
- Download URL: repo2pdf-0.1.3.tar.gz
- Upload date:
- Size: 6.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b0f814ffc50daed6bf6a5709a158f74180fb253acb77100cc393fd1c835826d3
|
|
| MD5 |
75ed72956fb73168fbb2701bdca14d09
|
|
| BLAKE2b-256 |
2ada09597333e290928b0c56cec7c9082076bc5c9d3adb0af4fc39608f839573
|
File details
Details for the file repo2pdf-0.1.3-py3-none-any.whl.
File metadata
- Download URL: repo2pdf-0.1.3-py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
046af085d6cc91330b1b6681ee53ea4c15327644afa714d4a97cfe3bceb1ead3
|
|
| MD5 |
1b790781a0f99e65a9c94f145f090a87
|
|
| BLAKE2b-256 |
788f72dcf8bd16d1356a5b6a765c408b0c2f23e9bb7abbcaef56b89c57f586f1
|