Metadata-Version: 2.4
Name: fastapi-translations
Version: 0.0.9
Summary: Translations report for FastAPI docs
Author-email: Rafael de Oliveira Marques <rafaelomarques@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Requires-Dist: gitpython<4.0.0,>=3.1.44
Requires-Dist: pydantic<3.0.0,>=2.10.6
Requires-Dist: typer<1.0.0,>=0.15.1
Description-Content-Type: text/markdown

# FastAPI Translations Management

Easy management for translations of the [FastAPI](https://github.com/fastapi/fastapi) project documentation.

✨ Inspired by the this [pull request](https://github.com/fastapi/fastapi/pull/11864) from [@lucasbalieiro](https://github.com/lucasbalieiro).

## 🙋🏾‍♀️ Who's this library for?

This is a very specific package, intended for contributors of [FastAPI](https://github.com/fastapi/fastapi) translations.

If you don't work with us, feel free to look around, but I don't think you'll be able to use it anywhere else

## Instalation

## 💽 Installation

Install using `pip install -U fastapi-translations`.

## ⌨️ Usage

After installing fastapi-translations, you'll be able to use it anywhere via the `fastapi_translations` command.

You can see all options with `fastapi_translations --help`:

![help](docs/img/help.png)

A basic usage is: `fastapi_translations -l pt -c`.

It will scan all english docs in FastAPI project, check which documents have translations into the language informed, and which documents, despite having a translation, are out of date.

You'll need to wait a little bit while it is analyzing all docs:

![processing](docs/img/processing.jpg)

And when it is done, you'll see a brief summary:

![summary](docs/img/summary.jpg)

And a `csv` file will be saved: `fastapi-translations-lang-{chosen-language}.csv` with all files, dates, etc. 🤗
