Skip to main content

Convert coding repositories into PDFs and JSON summaries

Project description

repo-2-pdf

CLI tool to 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
  • repo_output.json

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.5.tar.gz (16.6 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.5-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: repo2pdf-0.1.5.tar.gz
  • Upload date:
  • Size: 16.6 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.5.tar.gz
Algorithm Hash digest
SHA256 a0168a0b157b203459444f0f4101735e4ae7ec4763609fa24a2d2a553c009307
MD5 af06a8093278e27eea8ff117cf09740e
BLAKE2b-256 3af06edcdb3af0bc7f93556272e7528e69dbf95e2ad5661dafd7322cb73bc2d2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: repo2pdf-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 17.7 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 089694a983f4c709c8fc1c56a0b9b5c88abeb734ab111f3b904eb98ea20ccc5f
MD5 1379a664a93cf05604859ed7be965450
BLAKE2b-256 6deb3fca0eac18a40c2522dcdcd5d31d865e2d1026a01ecaa3559a15b860e625

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