A tool to facilitate the translation of GitHub README.md files using Ollama.
Project description
Documentation Support in Multiple Languages
| About | |
|---|---|
| English | Link to Head of Docs |
| Spanish | Link to Head of Docs |
| French | Link to Head of Docs |
| German | Link to Head of Docs |
| Italian | Link to Head of Docs |
| Portuguese | Link to Head of Docs |
Documentation Support in Multiple Languages
| About | |
|---|---|
| English | Link to Head of Docs |
| Spanish | Link to Head of Docs |
Readme Rosetta
Readme Rosetta is a tool designed to facilitate the translation of documentation, with a current focus on GitHub README.md files and Python libraries. It is fully compatible with GitBook and utilizes state-of-the-art Transformers models for high-quality translations.
Features
- Transformers Powered: Uses NLLB-200 via the
transformerslibrary for accurate multilingual translations. - GitBook Compatible: Generates documentation that can be easily imported and hosted on GitBook.
- Bulk Translation: Support for translating into 30+ languages in a single pass.
- Sphinx Integration: Automatically handles Sphinx i18n workflows.
- Universal Documentation: Makes Python libraries and READMEs accessible world-wide.
Getting Started
Installation
To install Readme Rosetta, follow these steps:
pip install readme-rosetta
Usage
readme-rosetta translate --input <path_to_input_file> --output <path_to_output_file> --target <target_language>
--input: Path to the input README.md file. --output: Path to the output translated file. --target: Target language for translation.
Documentation
Comprehensive documentation is available in the docs directory. It is built using Sphinx and supports multiple languages.
Building Documentation
To build the HTML documentation in English:
cd docs
pip install -r requirements.txt
make html
Multilingual Support (i18n)
The documentation is prepared for internationalization. To update or build translations for specific languages (e.g., Spanish):
cd docs
# Update translation catalogs
make translate-update LANGS=es
# Build translated HTML
make translate-build LANGS=es
You can build all supported languages at once by running make translate-build without the LANGS argument.
Supported Documentation Languages
The documentation setup includes optimized search support for:
- Built-in Support: English, Arabic, Danish, Dutch, Finnish, French, German, Hungarian, Italian, Japanese (via janome), Norwegian, Portuguese, Romanian, Russian, Spanish, Swedish, Turkish.
- Additional Support: Chinese (via jieba), Hindi.
The translated documentation will be available at docs/build/html/<language>/.
GitBook Integration
Readme Rosetta is designed to work seamlessly with GitBook. Since it generates standard Markdown, you can point GitBook to your repository or the generated README.md to have a multi-language documentation site in minutes.
Supported Languages (30+)
The following languages are supported and tested:
- en - English
- es - Spanish
- fr - French
- de - German
- it - Italian
- pt - Portuguese
- ru - Russian
- zh - Chinese
- ja - Japanese
- ar - Arabic
- hi - Hindi
- bn - Bengali
- id - Indonesian
- tr - Turkish
- vi - Vietnamese
- pl - Polish
- nl - Dutch
- sv - Swedish
- no - Norwegian
- da - Danish
- fi - Finnish
- el - Greek
- cs - Czech
- hu - Hungarian
- ro - Romanian
- uk - Ukrainian
- th - Thai
- ko - Korean
- he - Hebrew
- fa - Persian
- ms - Malay
Translator Backend
Readme Rosetta now defaults to using the NLLB-200 model via the transformers library (facebook/nllb-200-distilled-600M).
To use this:
- Ensure the required packages are installed:
pip install transformers torch sentencepiece protobuf
- The model will be automatically downloaded from Hugging Face on first run.
Contributing
We welcome contributions! If you'd like to contribute, please see our contributing guidelines.
Bug Reporting and Support
If you encounter any issues or need support, please open an issue.
License
This project is licensed under the MIT License.
Readme Rosetta Spanish
Readme Rosetta is a tool designed to facilitate the translation of documentation, with a current focus on GitHub README.md files and Python libraries. It is fully compatible with GitBook and utilizes state-of-the-art Transformers models for high-quality translations.
Features
- Transformers Powered: Uses NLLB-200 via the
transformerslibrary for accurate multilingual translations. - GitBook Compatible: Generates documentation that can be easily imported and hosted on GitBook.
- Bulk Translation: Support for translating into 30+ languages in a single pass.
- Sphinx Integration: Automatically handles Sphinx i18n workflows.
- Universal Documentation: Makes Python libraries and READMEs accessible world-wide.
Getting Started
Installation
To install Readme Rosetta, follow these steps:
pip install readme-rosetta
Usage
readme-rosetta translate --input <path_to_input_file> --output <path_to_output_file> --target <target_language>
--input: Path to the input README.md file. --output: Path to the output translated file. --target: Target language for translation.
Documentation
Comprehensive documentation is available in the docs directory. It is built using Sphinx and supports multiple languages.
Building Documentation
To build the HTML documentation in English:
cd docs
pip install -r requirements.txt
make html
Multilingual Support (i18n)
The documentation is prepared for internationalization. To update or build translations for specific languages (e.g., Spanish):
cd docs
# Update translation catalogs
make translate-update LANGS=es
# Build translated HTML
make translate-build LANGS=es
You can build all supported languages at once by running make translate-build without the LANGS argument.
Supported Documentation Languages
The documentation setup includes optimized search support for:
- Built-in Support: English, Arabic, Danish, Dutch, Finnish, French, German, Hungarian, Italian, Japanese (via janome), Norwegian, Portuguese, Romanian, Russian, Spanish, Swedish, Turkish.
- Additional Support: Chinese (via jieba), Hindi.
The translated documentation will be available at docs/build/html/<language>/.
GitBook Integration
Readme Rosetta is designed to work seamlessly with GitBook. Since it generates standard Markdown, you can point GitBook to your repository or the generated README.md to have a multi-language documentation site in minutes.
Supported Languages (30+)
The following languages are supported and tested:
- en - English
- es - Spanish
- fr - French
- de - German
- it - Italian
- pt - Portuguese
- ru - Russian
- zh - Chinese
- ja - Japanese
- ar - Arabic
- hi - Hindi
- bn - Bengali
- id - Indonesian
- tr - Turkish
- vi - Vietnamese
- pl - Polish
- nl - Dutch
- sv - Swedish
- no - Norwegian
- da - Danish
- fi - Finnish
- el - Greek
- cs - Czech
- hu - Hungarian
- ro - Romanian
- uk - Ukrainian
- th - Thai
- ko - Korean
- he - Hebrew
- fa - Persian
- ms - Malay
Translator Backend
Readme Rosetta now defaults to using the NLLB-200 model via the transformers library (facebook/nllb-200-distilled-600M).
To use this:
- Ensure the required packages are installed:
pip install transformers torch sentencepiece protobuf
- The model will be automatically downloaded from Hugging Face on first run.
Contributing
We welcome contributions! If you'd like to contribute, please see our contributing guidelines.
Bug Reporting and Support
If you encounter any issues or need support, please open an issue.
License
This project is licensed under the MIT License.
Readme Rosetta French
Readme Rosetta is a tool designed to facilitate the translation of documentation, with a current focus on GitHub README.md files and Python libraries. It is fully compatible with GitBook and utilizes state-of-the-art Transformers models for high-quality translations.
Features
- Transformers Powered: Uses NLLB-200 via the
transformerslibrary for accurate multilingual translations. - GitBook Compatible: Generates documentation that can be easily imported and hosted on GitBook.
- Bulk Translation: Support for translating into 30+ languages in a single pass.
- Sphinx Integration: Automatically handles Sphinx i18n workflows.
- Universal Documentation: Makes Python libraries and READMEs accessible world-wide.
Getting Started
Installation
To install Readme Rosetta, follow these steps:
pip install readme-rosetta
Usage
Sphinx Documentation Setup & Translation
To automatically setup Sphinx, generate API documentation, and translate all .po files for multiple languages:
readme-rosetta . --sphinx --langs es fr hi de it ja ko ru
Bulk README Translation
To translate your README_SOURCE.md into multiple languages and append them to README.md with a language selector table:
readme-rosetta README_SOURCE.md --langs es fr hi de it ja
Legacy / Single Translation
readme-rosetta en es README_SOURCE.md
Documentation
Comprehensive documentation is available in the docs directory. It is built using Sphinx and supports multiple languages.
Building Documentation
To build the HTML documentation in English:
cd docs
pip install -r requirements.txt
make html
Multilingual Support (i18n)
The documentation is prepared for internationalization. To update or build translations for specific languages (e.g., Spanish):
cd docs
# Update translation catalogs
make translate-update LANGS=es
# Build translated HTML
make translate-build LANGS=es
You can build all supported languages at once by running make translate-build without the LANGS argument.
Supported Documentation Languages
The documentation setup includes optimized search support for:
- Built-in Support: English, Arabic, Danish, Dutch, Finnish, French, German, Hungarian, Italian, Japanese (via janome), Norwegian, Portuguese, Romanian, Russian, Spanish, Swedish, Turkish.
- Additional Support: Chinese (via jieba), Hindi.
The translated documentation will be available at docs/build/html/<language>/.
GitBook Integration
Readme Rosetta is designed to work seamlessly with GitBook. Since it generates standard Markdown, you can point GitBook to your repository or the generated README.md to have a multi-language documentation site in minutes.
Supported Languages (30+)
The following languages are supported and tested:
- en - English
- es - Spanish
- fr - French
- de - German
- it - Italian
- pt - Portuguese
- ru - Russian
- zh - Chinese
- ja - Japanese
- ar - Arabic
- hi - Hindi
- bn - Bengali
- id - Indonesian
- tr - Turkish
- vi - Vietnamese
- pl - Polish
- nl - Dutch
- sv - Swedish
- no - Norwegian
- da - Danish
- fi - Finnish
- el - Greek
- cs - Czech
- hu - Hungarian
- ro - Romanian
- uk - Ukrainian
- th - Thai
- ko - Korean
- he - Hebrew
- fa - Persian
- ms - Malay
Translator Backend
Readme Rosetta now defaults to using the NLLB-200 model via the transformers library (facebook/nllb-200-distilled-600M).
To use this:
- Ensure the required packages are installed:
pip install transformers torch sentencepiece protobuf
- The model will be automatically downloaded from Hugging Face on first run.
Contributing
We welcome contributions! If you'd like to contribute, please see our contributing guidelines.
Bug Reporting and Support
If you encounter any issues or need support, please open an issue.
License
This project is licensed under the MIT License.
Readme Rosetta German
Readme Rosetta is a tool designed to facilitate the translation of documentation, with a current focus on GitHub README.md files and Python libraries. It is fully compatible with GitBook and utilizes state-of-the-art Transformers models for high-quality translations.
Features
- Transformers Powered: Uses NLLB-200 via the
transformerslibrary for accurate multilingual translations. - GitBook Compatible: Generates documentation that can be easily imported and hosted on GitBook.
- Bulk Translation: Support for translating into 30+ languages in a single pass.
- Sphinx Integration: Automatically handles Sphinx i18n workflows.
- Universal Documentation: Makes Python libraries and READMEs accessible world-wide.
Getting Started
Installation
To install Readme Rosetta, follow these steps:
pip install readme-rosetta
Usage
Sphinx Documentation Setup & Translation
To automatically setup Sphinx, generate API documentation, and translate all .po files for multiple languages:
readme-rosetta . --sphinx --langs es fr hi de it ja ko ru
Bulk README Translation
To translate your README_SOURCE.md into multiple languages and append them to README.md with a language selector table:
readme-rosetta README_SOURCE.md --langs es fr hi de it ja
Legacy / Single Translation
readme-rosetta en es README_SOURCE.md
Documentation
Comprehensive documentation is available in the docs directory. It is built using Sphinx and supports multiple languages.
Building Documentation
To build the HTML documentation in English:
cd docs
pip install -r requirements.txt
make html
Multilingual Support (i18n)
The documentation is prepared for internationalization. To update or build translations for specific languages (e.g., Spanish):
cd docs
# Update translation catalogs
make translate-update LANGS=es
# Build translated HTML
make translate-build LANGS=es
You can build all supported languages at once by running make translate-build without the LANGS argument.
Supported Documentation Languages
The documentation setup includes optimized search support for:
- Built-in Support: English, Arabic, Danish, Dutch, Finnish, French, German, Hungarian, Italian, Japanese (via janome), Norwegian, Portuguese, Romanian, Russian, Spanish, Swedish, Turkish.
- Additional Support: Chinese (via jieba), Hindi.
The translated documentation will be available at docs/build/html/<language>/.
GitBook Integration
Readme Rosetta is designed to work seamlessly with GitBook. Since it generates standard Markdown, you can point GitBook to your repository or the generated README.md to have a multi-language documentation site in minutes.
Supported Languages (30+)
The following languages are supported and tested:
- en - English
- es - Spanish
- fr - French
- de - German
- it - Italian
- pt - Portuguese
- ru - Russian
- zh - Chinese
- ja - Japanese
- ar - Arabic
- hi - Hindi
- bn - Bengali
- id - Indonesian
- tr - Turkish
- vi - Vietnamese
- pl - Polish
- nl - Dutch
- sv - Swedish
- no - Norwegian
- da - Danish
- fi - Finnish
- el - Greek
- cs - Czech
- hu - Hungarian
- ro - Romanian
- uk - Ukrainian
- th - Thai
- ko - Korean
- he - Hebrew
- fa - Persian
- ms - Malay
Translator Backend
Readme Rosetta now defaults to using the NLLB-200 model via the transformers library (facebook/nllb-200-distilled-600M).
To use this:
- Ensure the required packages are installed:
pip install transformers torch sentencepiece protobuf
- The model will be automatically downloaded from Hugging Face on first run.
Contributing
We welcome contributions! If you'd like to contribute, please see our contributing guidelines.
Bug Reporting and Support
If you encounter any issues or need support, please open an issue.
License
This project is licensed under the MIT License.
Readme Rosetta Italian
Readme Rosetta is a tool designed to facilitate the translation of documentation, with a current focus on GitHub README.md files and Python libraries. It is fully compatible with GitBook and utilizes state-of-the-art Transformers models for high-quality translations.
Features
- Transformers Powered: Uses NLLB-200 via the
transformerslibrary for accurate multilingual translations. - GitBook Compatible: Generates documentation that can be easily imported and hosted on GitBook.
- Bulk Translation: Support for translating into 30+ languages in a single pass.
- Sphinx Integration: Automatically handles Sphinx i18n workflows.
- Universal Documentation: Makes Python libraries and READMEs accessible world-wide.
Getting Started
Installation
To install Readme Rosetta, follow these steps:
pip install readme-rosetta
Usage
Sphinx Documentation Setup & Translation
To automatically setup Sphinx, generate API documentation, and translate all .po files for multiple languages:
readme-rosetta . --sphinx --langs es fr hi de it ja ko ru
Bulk README Translation
To translate your README_SOURCE.md into multiple languages and append them to README.md with a language selector table:
readme-rosetta README_SOURCE.md --langs es fr hi de it ja
Legacy / Single Translation
readme-rosetta en es README_SOURCE.md
Documentation
Comprehensive documentation is available in the docs directory. It is built using Sphinx and supports multiple languages.
Building Documentation
To build the HTML documentation in English:
cd docs
pip install -r requirements.txt
make html
Multilingual Support (i18n)
The documentation is prepared for internationalization. To update or build translations for specific languages (e.g., Spanish):
cd docs
# Update translation catalogs
make translate-update LANGS=es
# Build translated HTML
make translate-build LANGS=es
You can build all supported languages at once by running make translate-build without the LANGS argument.
Supported Documentation Languages
The documentation setup includes optimized search support for:
- Built-in Support: English, Arabic, Danish, Dutch, Finnish, French, German, Hungarian, Italian, Japanese (via janome), Norwegian, Portuguese, Romanian, Russian, Spanish, Swedish, Turkish.
- Additional Support: Chinese (via jieba), Hindi.
The translated documentation will be available at docs/build/html/<language>/.
GitBook Integration
Readme Rosetta is designed to work seamlessly with GitBook. Since it generates standard Markdown, you can point GitBook to your repository or the generated README.md to have a multi-language documentation site in minutes.
Supported Languages (30+)
The following languages are supported and tested:
- en - English
- es - Spanish
- fr - French
- de - German
- it - Italian
- pt - Portuguese
- ru - Russian
- zh - Chinese
- ja - Japanese
- ar - Arabic
- hi - Hindi
- bn - Bengali
- id - Indonesian
- tr - Turkish
- vi - Vietnamese
- pl - Polish
- nl - Dutch
- sv - Swedish
- no - Norwegian
- da - Danish
- fi - Finnish
- el - Greek
- cs - Czech
- hu - Hungarian
- ro - Romanian
- uk - Ukrainian
- th - Thai
- ko - Korean
- he - Hebrew
- fa - Persian
- ms - Malay
Translator Backend
Readme Rosetta now defaults to using the NLLB-200 model via the transformers library (facebook/nllb-200-distilled-600M).
To use this:
- Ensure the required packages are installed:
pip install transformers torch sentencepiece protobuf
- The model will be automatically downloaded from Hugging Face on first run.
Contributing
We welcome contributions! If you'd like to contribute, please see our contributing guidelines.
Bug Reporting and Support
If you encounter any issues or need support, please open an issue.
License
This project is licensed under the MIT License.
Readme Rosetta Portuguese
Readme Rosetta is a tool designed to facilitate the translation of documentation, with a current focus on GitHub README.md files and Python libraries. It is fully compatible with GitBook and utilizes state-of-the-art Transformers models for high-quality translations.
Features
- Transformers Powered: Uses NLLB-200 via the
transformerslibrary for accurate multilingual translations. - GitBook Compatible: Generates documentation that can be easily imported and hosted on GitBook.
- Bulk Translation: Support for translating into 30+ languages in a single pass.
- Sphinx Integration: Automatically handles Sphinx i18n workflows.
- Universal Documentation: Makes Python libraries and READMEs accessible world-wide.
Getting Started
Installation
To install Readme Rosetta, follow these steps:
pip install readme-rosetta
Usage
Sphinx Documentation Setup & Translation
To automatically setup Sphinx, generate API documentation, and translate all .po files for multiple languages:
readme-rosetta . --sphinx --langs es fr hi de it ja ko ru
Bulk README Translation
To translate your README_SOURCE.md into multiple languages and append them to README.md with a language selector table:
readme-rosetta README_SOURCE.md --langs es fr hi de it ja
Legacy / Single Translation
readme-rosetta en es README_SOURCE.md
Documentation
Comprehensive documentation is available in the docs directory. It is built using Sphinx and supports multiple languages.
Building Documentation
To build the HTML documentation in English:
cd docs
pip install -r requirements.txt
make html
Multilingual Support (i18n)
The documentation is prepared for internationalization. To update or build translations for specific languages (e.g., Spanish):
cd docs
# Update translation catalogs
make translate-update LANGS=es
# Build translated HTML
make translate-build LANGS=es
You can build all supported languages at once by running make translate-build without the LANGS argument.
Supported Documentation Languages
The documentation setup includes optimized search support for:
- Built-in Support: English, Arabic, Danish, Dutch, Finnish, French, German, Hungarian, Italian, Japanese (via janome), Norwegian, Portuguese, Romanian, Russian, Spanish, Swedish, Turkish.
- Additional Support: Chinese (via jieba), Hindi.
The translated documentation will be available at docs/build/html/<language>/.
GitBook Integration
Readme Rosetta is designed to work seamlessly with GitBook. Since it generates standard Markdown, you can point GitBook to your repository or the generated README.md to have a multi-language documentation site in minutes.
Supported Languages (30+)
The following languages are supported and tested:
- en - English
- es - Spanish
- fr - French
- de - German
- it - Italian
- pt - Portuguese
- ru - Russian
- zh - Chinese
- ja - Japanese
- ar - Arabic
- hi - Hindi
- bn - Bengali
- id - Indonesian
- tr - Turkish
- vi - Vietnamese
- pl - Polish
- nl - Dutch
- sv - Swedish
- no - Norwegian
- da - Danish
- fi - Finnish
- el - Greek
- cs - Czech
- hu - Hungarian
- ro - Romanian
- uk - Ukrainian
- th - Thai
- ko - Korean
- he - Hebrew
- fa - Persian
- ms - Malay
Translator Backend
Readme Rosetta now defaults to using the NLLB-200 model via the transformers library (facebook/nllb-200-distilled-600M).
To use this:
- Ensure the required packages are installed:
pip install transformers torch sentencepiece protobuf
- The model will be automatically downloaded from Hugging Face on first run.
Contributing
We welcome contributions! If you'd like to contribute, please see our contributing guidelines.
Bug Reporting and Support
If you encounter any issues or need support, please open an issue.
License
This project is licensed under the MIT License.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file readme_rosetta-0.1.4.tar.gz.
File metadata
- Download URL: readme_rosetta-0.1.4.tar.gz
- Upload date:
- Size: 12.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d9cde4a7d622baaf3a3c6debd245c242b4581584347008b994383935673b2860
|
|
| MD5 |
155815deeea70e1409790aa4b8931043
|
|
| BLAKE2b-256 |
6498bb8ab926fc3fee77c8d754938a74dd7631ac450075525e30d48963958e9a
|
Provenance
The following attestation bundles were made for readme_rosetta-0.1.4.tar.gz:
Publisher:
publish.yml on juleshenry/readme_rosetta
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
readme_rosetta-0.1.4.tar.gz -
Subject digest:
d9cde4a7d622baaf3a3c6debd245c242b4581584347008b994383935673b2860 - Sigstore transparency entry: 954369478
- Sigstore integration time:
-
Permalink:
juleshenry/readme_rosetta@7d9111c6d155b3b586fdf0c2f7b10b77b1a69d76 -
Branch / Tag:
refs/tags/v0.1.4 - Owner: https://github.com/juleshenry
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@7d9111c6d155b3b586fdf0c2f7b10b77b1a69d76 -
Trigger Event:
release
-
Statement type:
File details
Details for the file readme_rosetta-0.1.4-py3-none-any.whl.
File metadata
- Download URL: readme_rosetta-0.1.4-py3-none-any.whl
- Upload date:
- Size: 10.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
90302912698967f170e8fd9cbbcc10c76c4745d2127f293dcd1f3cd7d32b290d
|
|
| MD5 |
a7e0779297f4e9f821b129479f6fee84
|
|
| BLAKE2b-256 |
beebc5ca7d8a89c82594b9007330d0862719caeba2e62486eabfa36a3cf70954
|
Provenance
The following attestation bundles were made for readme_rosetta-0.1.4-py3-none-any.whl:
Publisher:
publish.yml on juleshenry/readme_rosetta
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
readme_rosetta-0.1.4-py3-none-any.whl -
Subject digest:
90302912698967f170e8fd9cbbcc10c76c4745d2127f293dcd1f3cd7d32b290d - Sigstore transparency entry: 954369480
- Sigstore integration time:
-
Permalink:
juleshenry/readme_rosetta@7d9111c6d155b3b586fdf0c2f7b10b77b1a69d76 -
Branch / Tag:
refs/tags/v0.1.4 - Owner: https://github.com/juleshenry
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@7d9111c6d155b3b586fdf0c2f7b10b77b1a69d76 -
Trigger Event:
release
-
Statement type:
