plaguss / translate-md

Python library to translate markdown files from english to spanish, leveraging spanglish

translate-md

Python client to spanglish, and a bit more. Translate your markdown files from english 🇬🇧 to spanish 🇪🇸.

CI/CD
Docs
Package
Meta

---

This project was developed for my personal use: translating markdown files from my blog posts. It may be useful for somebody (I would be honored to listen to that), but please don't expect everything correct to the detail.

Anyway, the API is not expected to change much unless some extra feature is required. Contributions are welcome!

To see the features along some examples, please visit the docs.

🔧 Installation

pip install translate-md

This client depends on a service which is currently expected tu run locally. You would need to get it to work:

Additional dependencies

You will need spanglish running in order to start working. The easiest way is to clone the repo and use docker for it. Get the service up you should be ready to go.

CLI version

It may be convenient for some cases, so the library comes with a CLI with a subset of the functionality:

pip install translate-md[cli]

Or maybe better with pipx

pipx install translate-md[cli]

Visit the docs for further information.

📝 Documentation

The documentation is made with Material for MkDocs and is hosted by GitHub Pages.

translate-md's Issues

Correct docs for installation

The commands for installing the cli version should be:

pip install "translate-md[cli]"
pipx install "translate-md[cli]"