Skip to main content

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:

  1. Select local or remote repository
  2. Provide the local repo path or GitHub URL
  3. Choose an output location
  4. Exclude any file types you don't want included (e.g., .png, .jpg)
  5. 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 CLI Interface

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

repo2pdf-0.1.2.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

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

repo2pdf-0.1.2-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: repo2pdf-0.1.2.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for repo2pdf-0.1.2.tar.gz
Algorithm Hash digest
SHA256 65a334c93de5989945c0bc74a3aae4068701e7346a6c382426fce8f587b79821
MD5 7ee85b96772cfd16922a761ae9826333
BLAKE2b-256 2928e17154d5809a2e5a931b4058150ef82a744182e71a4e6a0e8927fcd22e6f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: repo2pdf-0.1.2-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

Hashes for repo2pdf-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e00056b62cf3e50820297e7b25ca59f24b0d9f483d8c0e85966b3b37d98e99a3
MD5 5d5fd5e2273f584a9c6c35eaaa067db8
BLAKE2b-256 7ef9242ad2b3385a9ef7011e0e0fe163e45f949ef14028131eed1eae35f1ed5b

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