fastapi-rosetta 0.1.0__tar.gz

fastapi_rosetta-0.1.0/.gitignore

@@ -0,0 +1,217 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

fastapi_rosetta-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+repos:
+  # ----------------------------------
+  # Basic hygiene hooks
+  # ----------------------------------
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+        args: ["--maxkb=750"]
+      - id: check-toml
+      - id: check-yaml
+        args: ["--unsafe"]
+      - id: check-merge-conflict
+
+  # ----------------------------------
+  # Ruff - Linter + isort replacement
+  # ----------------------------------
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.5
+    hooks:
+      - id: ruff
+        args:
+          - --fix
+          - --exit-non-zero-on-fix
+        language_version: python3.13
+
+  # ----------------------------------
+  # Black - Code formatter
+  # ----------------------------------
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.4.2
+    hooks:
+      - id: black
+        language_version: python3.13
+        args: ["--line-length=88"]
+
+  # ----------------------------------
+  # Mypy - Type checking
+  # ----------------------------------
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: uv run mypy .
+        language: system
+        types: [python]
+        pass_filenames: false

fastapi_rosetta-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

fastapi_rosetta-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008-2023 Marco Bonetti
+
+ Permission is hereby granted, free of charge, to any person
+ obtaining a copy of this software and associated documentation
+ files (the "Software"), to deal in the Software without
+ restriction, including without limitation the rights to use,
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the
+ Software is furnished to do so, subject to the following
+ conditions:
+
+ The above copyright notice and this permission notice shall be
+ included in all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ OTHER DEALINGS IN THE SOFTWARE.

fastapi_rosetta-0.1.0/PKG-INFO

@@ -0,0 +1,243 @@
+Metadata-Version: 2.4
+Name: fastapi-rosetta
+Version: 0.1.0
+Summary: A FastAPI-native translation management interface for gettext translation files.
+Project-URL: Homepage, https://github.com/rezatn0934/fastapi-rosetta.git
+Project-URL: Repository, https://github.com/rezatn0934/fastapi-rosetta.git
+Author-email: Reza Teymouri Nejad <rezatn0934@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: fastapi,gettext,i18n,internationalization,rosetta,translation
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: fastapi>=0.133.1
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: polib>=1.2.0
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: requests>=2.34.2
+Provides-Extra: google
+Requires-Dist: google-cloud-translate>=3.27.0; extra == 'google'
+Provides-Extra: openai
+Requires-Dist: openai>=2.53.0; extra == 'openai'
+Description-Content-Type: text/markdown
+
+# FastAPI Rosetta
+
+A modern translation management interface for **FastAPI** applications using GNU gettext (`.po`) files.
+
+FastAPI Rosetta lets translators and developers edit, search, and manage translation files directly from a clean web interface—without relying on Django.
+
+![FastAPI Rosetta](docs/images/editor.png)
+
+---
+
+## Features
+
+* 🌍 Browse all translation files from one place
+* ✏️ Edit translations directly in your browser
+* 🔍 Search messages instantly
+* 🏷️ Filter translated, untranslated, or fuzzy entries
+* 🌐 Support multiple languages
+* 🔄 Reference another language while translating
+* 🤖 Machine translation support (Google Cloud & OpenAI)
+* 📦 Download translations as ZIP files
+* ⚡ Automatically compile `.mo` files after saving
+* 🎨 Lightweight, FastAPI-native interface
+
+---
+
+## Installation
+
+Install the package:
+
+```bash
+uv add fastapi-rosetta
+```
+
+Or using pip:
+
+```bash
+pip install fastapi-rosetta
+```
+
+### Optional translation providers
+
+Google Cloud
+
+```bash
+uv add "fastapi-rosetta[google]"
+```
+
+OpenAI
+
+```bash
+uv add "fastapi-rosetta[openai]"
+```
+
+Both
+
+```bash
+uv add "fastapi-rosetta[google,openai]"
+```
+
+---
+
+## Quick Start
+
+```python
+from pathlib import Path
+
+from fastapi import FastAPI
+
+
+from fastapi_rosetta import RosettaConfig, configure, mount_static
+from fastapi_rosetta import router as rosetta_router
+
+app = FastAPI()
+
+BASE_DIR = Path(__file__).resolve().parent
+
+configure(
+    RosettaConfig(
+        requires_auth=True,
+        locale_paths=(
+            str(BASE_DIR / "locales"),
+        ),
+        languages=(
+            ("fa", "Persian"),
+            ("en", "English"),
+        ),
+        messages_per_page=20,
+    )
+)
+
+app.include_router(rosetta_router)
+
+mount_static(app)
+```
+
+Start your application:
+
+```bash
+uvicorn main:app --reload
+```
+
+Then open:
+
+```
+http://localhost:8000/rosetta/
+```
+
+---
+
+## Translation Files
+
+FastAPI Rosetta works with standard GNU gettext files.
+
+Example directory structure:
+
+```text
+locale/
+├── en/
+│   └── LC_MESSAGES/
+│       ├── messages.po
+│       └── messages.mo
+│
+├── fa/
+│   └── LC_MESSAGES/
+│       ├── messages.po
+│       └── messages.mo
+│
+└── de/
+    └── LC_MESSAGES/
+        ├── messages.po
+        └── messages.mo
+```
+
+---
+
+## Typical Workflow
+
+1. Open the Rosetta interface.
+2. Select a language.
+3. Choose a translation file.
+4. Search or browse messages.
+5. Edit translations.
+6. Save your changes.
+7. Download the updated translation files if needed.
+
+---
+
+## Use Cases
+
+FastAPI Rosetta is suitable for:
+
+* SaaS applications
+* Admin dashboards
+* Business applications
+* Multi-language websites
+* APIs with translated content
+* Open-source projects
+* Internal company tools
+* FastAPI microservices
+
+---
+
+## Machine Translation
+
+FastAPI Rosetta can suggest translations using supported providers.
+
+Currently supported:
+
+* Google Cloud Translation
+* OpenAI
+
+These providers are optional and can be installed only when needed.
+
+---
+
+## Screenshots
+
+### Translation Editor
+
+![Translation Editor](docs/images/editor.png)
+
+### Translation Files
+
+![Translation Files](docs/images/file-list.png)
+
+---
+
+## Why FastAPI Rosetta?
+
+* No Django dependency
+* Familiar gettext workflow
+* Easy to integrate
+* Simple configuration
+* Clean web interface
+* Optional AI-assisted translation
+* Uses standard `.po` and `.mo` files
+
+
+---
+
+## License
+
+MIT License
+
+---
+
+## Credits
+
+FastAPI Rosetta is inspired by the excellent **Django Rosetta** project and brings a similar translation experience to the FastAPI ecosystem.