Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icij/es-translator
A cli tool to translate Elastichsearch field.
https://github.com/icij/es-translator
command-line elasticsearch python translation
Last synced: 13 days ago
JSON representation
A cli tool to translate Elastichsearch field.
- Host: GitHub
- URL: https://github.com/icij/es-translator
- Owner: ICIJ
- License: mit
- Created: 2019-04-29T09:18:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T13:24:21.000Z (7 months ago)
- Last Synced: 2024-04-24T16:21:46.364Z (7 months ago)
- Topics: command-line, elasticsearch, python, translation
- Language: Python
- Homepage: https://icij.github.io/es-translator/
- Size: 4.01 MB
- Stars: 12
- Watchers: 9
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ES Translator [](https://github.com/ICIJ/es-translator/actions) [](https://pypi.org/project/es-translator/)
A lazy yet bulletproof machine translation tool for Elastichsearch.
## Installation (Ubuntu)
Install Apertium:
```bash
wget https://apertium.projectjj.com/apt/install-nightly.sh -O - | sudo bash
sudo apt install apertium-all-dev
```
Then install es-translator with pip:
```bash
python3 -m pip install --user es-translator
```
## Installation (Docker)
Nothing to do as long as you have Docker on your system:
```
docker run -it icij/es-translator es-translator --help
```
## Usage
The primarly command from EsTranslator to translate documents is `es-translator`:
```
Usage: es-translator [OPTIONS]
Options:
-u, --url TEXT Elastichsearch URL
-i, --index TEXT Elastichsearch Index
-r, --interpreter TEXT Interpreter to use to perform the
translation
-s, --source-language TEXT Source language to translate from
[required]
-t, --target-language TEXT Target language to translate to [required]
--intermediary-language TEXT An intermediary language to use when no
translation is available between the source
and the target. If none is provided this
will be calculated automatically.
--source-field TEXT Document field to translate
--target-field TEXT Document field where the translations are
stored
-q, --query-string TEXT Search query string to filter result
-d, --data-dir PATH Path to the directory where to language
model will be downloaded
--scan-scroll TEXT Scroll duration (set to higher value if
you're processing a lot of documents)
--dry-run Don't save anything in Elasticsearch
-f, --force Override existing translation in
Elasticsearch
--pool-size INTEGER Number of parallel processes to start
--pool-timeout INTEGER Timeout to add a translation
--throttle INTEGER Throttle between each translation (in ms)
--syslog-address TEXT Syslog address
--syslog-port INTEGER Syslog port
--syslog-facility TEXT Syslog facility
--stdout-loglevel TEXT Change the default log level for stdout
error handler
--progressbar / --no-progressbar
Display a progressbar
--plan Plan translations into a queue instead of
processing them npw
--broker-url TEXT Celery broker URL (only needed when planning
translation)
--max-content-length TEXT Max translated content length
(<[0-9]+[KMG]?>) to avoid highlight
errors(see http://github.com/ICIJ/datashare/
issues/1184)
--help Show this message and exit.
```
Learn more about how to use this command in the [Usage Documentation](https://icij.github.io/es-translator/usage/).
## API
You can explore the [API Documentation](https://icij.github.io/es-translator/api/) for more information.
## Contributing
Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue on the [GitHub repository](https://github.com/icij/es-translator). If you're willing to help, check the page about [how to contribute](https://icij.github.io/es-translator/contributing/) to this project.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/icij/es-translator/blob/main/LICENSE.md) file for more details.