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 giving LLMs full context of your codebase

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

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.4.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.4-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: repo2pdf-0.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 a588a7b35421ebf44effc9be0e2a383122bd36247ed70df4c773fc77cd3500af
MD5 cc2ec4a790c414e7aedc0cc59629bb83
BLAKE2b-256 45eee981e93fcb99f99b89bb30ba0ae1b78902bde0adeb1bbd678e23ccd542ff

See more details on using hashes here.

File details

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

File metadata

  • Download URL: repo2pdf-0.1.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 22a8c3b7cb558d6e713db075b5482a3bf8b2d465ab3b7bbd5bad2a5c213f58cb
MD5 285f232efa143eb521f74e7b7cace98b
BLAKE2b-256 bd3a72433b2720ffb8055f3797bc955cf030c74053b3cc3720bb61e31257f7d2

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