Skip to main content

Compiles all readable files into a single PDF for easy sharing with LLMs.

Project description

PDF-GPT

Have you ever tried to fix one of your coding problems but you found the process of slowly highlighting all text, copying it, pasting it into your LLM of choice, making minor edits with instructions, then doing that entire process for eery file you wish to address, just a little bit estrenuous? Now with PDF-GPT all you need to do is write six golden letters, pdfgpt, in your terminal and a .pdf file will magically appear right inside of your directory. All you have to do now is upload that .pdf file to your favorite LLM and save your precious seconds!

Disclaimer: I am not responsible for your beloved LLM messing up your program and/or hallucinating with solutions. PDF-GPT's PDFs work very well, it is your code that does not. If you decide to report your spaghetti code to the Issues tab, I may end up laughing at it, and if you're funny enough I'll print it out and tape it to my bedroom wall. So, if you're a comedian, please consider reporting your LLM's issues directly to the Issues tab.

Installation

To install PDF-GPT, simply run the following command into your terminal:

pip install pdfgpt-llm

Commands List

Commands

This project includes several terminal commands for managing the workflow and accessing information. To run them, simply type the command of your choice Below is a list of available commands:

Command Description
pdfgpt Run this command to have your entire repository compiled into one simple .pdf file that will be stored in the directory!
commandlist Displays a list of all available commands in the terminal.
ignoreadd <FILENAME> Adds a file to the ignore list based on its filename.
ignoreremove <FILENAME> Removes a file from the ignore list based on its filename.
ignoreshow Shows the current contents of the ignore list in the terminal.
lastupdate Displays information about the latest update.
repository Prints the link to the GitHub repository for PDFGPT. Chances are if you're reading this, you probably know how that command works!

Features Explained

Ignore List

The Ignore List essentially acts as a .gitignore, as any file name added to the list will be... ignored... by PDFGPT. Keep in mind they work off a filename basis so do not write down the file path as well.

Web devs, forgive me.

Demo Run

Here's a quick demo of me using a PDFGPT-created .pdf file to have ChatGPT fix issues that it may find across ten different programs from ten different languages! Keep in mind this was done BEFORE I added terminal accessibility, so instead of being ran through the terminal, the PDF was compiled by running PDFGPT.py.

Demo Run

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

pdfgpt_llm-0.2.0.tar.gz (42.5 kB view details)

Uploaded Source

Built Distribution

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

pdfgpt_llm-0.2.0-py3-none-any.whl (29.7 kB view details)

Uploaded Python 3

File details

Details for the file pdfgpt_llm-0.2.0.tar.gz.

File metadata

  • Download URL: pdfgpt_llm-0.2.0.tar.gz
  • Upload date:
  • Size: 42.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for pdfgpt_llm-0.2.0.tar.gz
Algorithm Hash digest
SHA256 7fea6de16bbe82a420fe1f2ea557e02ca68e99b3be75d5e94d07825b215d8350
MD5 07139817fa6ec40a10cef1ae44ec9e6c
BLAKE2b-256 a693180d10863d49f815bbaf8edd0dd6fa11b36a652c7995e78f6462b9cb7485

See more details on using hashes here.

File details

Details for the file pdfgpt_llm-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: pdfgpt_llm-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 29.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for pdfgpt_llm-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd52efda56d79b97e46e907a025465e434041b0adf2224694efe1cf616800ef3
MD5 0d695cbe9c3abe675bf33883639284b9
BLAKE2b-256 0acebb23f4be771ca731b9331d5b44529ac4a763997357390efe6de6c457727a

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