pdf2joplin 1.0.0

Convert your PDF documents to Markdown notes with KaTeX support with the help of OpenAI.

Convert your PDF documents to Markdown notes with KaTeX support with the help of OpenAI.

Report Bug · Request Feature · PyPI

Features

• Takes as INPUT a pdf and transforms it into Markdown with KaTeX using OpenAI.

(back to top)

Installation

You can install pdf2joplin using pip.

pip install pdf2joplin

(back to top)

Usage

If you are using Mac, then you need to install poppler.

brew install poppler

After installing it, you can run it like this:

> pdf2joplin --help

Usage: pdf2joplin [OPTIONS]

  Convert your PDF documents to Markdown notes with KaTeX support with the help of OpenAI.

Options:
  --version          Show the version and exit.
  --pdf TEXT         The filepath of the PDF that you wish to convert.  [required]
  --output TEXT      The filepath of the final markdown file.  [required]
  --openai-key TEXT  The OpenAI key used to perform the prompt queries.  [required]
  --skip INTEGER     Number of pages to skip.
  --help             Show this message and exit.

(back to top)

Developing

In order to start developing you will need to to follow the instructions below.

> pyenv install 3.12.6
> pyenv global 3.12.6
> python3 -m venv .venv
> source .venv/bin/activate
> (.venv) pip install ruff pre-commit
> (.venv) pip install -e .
> (.venv) pdf2joplin --version
> (.venv) ruff check --fix

(back to top)

Dependencies

• click
• pdf2image
• openai-python
• pydantic
• tqdm

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project.
2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
3. Commit your Changes (git commit -m 'Add some AmazingFeature').
4. Push to the Branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

(back to top)