pypandoc

(โ˜… 1,151)

Thin wrapper for "pandoc" (MIT)

  • .flake8
  • .gitignore
  • .pre-commit-config.yaml
  • docker-compose.yml
  • Dockerfile
  • filter_test.md
  • LICENSE
  • pyproject.toml
  • README.md
  • release.md
  • tea.yaml
  • uv.lock

# Installation Guide

1. Get the code
git clone https://github.com/JessicaTegner/pypandoc

Downloads the entire project code from GitHub to your computer.

cd pypandoc

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install pypandoc

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install pypandoc_binary

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install pypandoc[tinytex]

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install pypandoc

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install pypandoc_binary

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install pypandoc[tinytex]

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation