# Offline Translator
[](https://github.com/Dashstrom/offline-translator/actions/workflows/docs.yml)
[](https://github.com/Dashstrom/offline-translator/actions/workflows/lint.yml)
[](https://github.com/Dashstrom/offline-translator/actions/workflows/tests.yml)
[](https://github.com/Dashstrom/offline-translator)
[](https://pypi.org/project/offline-translator)
[](https://static.pepy.tech/badge/offline-translator)
[](https://github.com/Dashstrom/offline-translator/blob/main/LICENSE)
## Description
Offline Translator GUI using Opus-MT.
## Installation
First, you need to install [Python](https://www.python.org/downloads).
Then you need to install `pipx` for install `offline-translator` as an application.
```bash
pip install pipx
pipx ensurepath
pipx install offline-translator
offline-translator
```
## Development
### Contributing
Contributions are very welcome. Tests can be run with `poe check`, please
ensure the coverage at least stays the same before you submit a pull request.
### Setup
You need to install [Poetry](https://python-poetry.org/docs/#installation)
and [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
for work with this project.
```bash
git clone https://github.com/Dashstrom/offline-translator
cd offline-translator
poetry install --all-extras
poetry run poe setup
poetry shell
```
### Poe
Poe is available for help you to run tasks.
```text
test Run test suite.
lint Run linters : ruff linter, ruff formatter and mypy.
format Run linters in fix mode.
check Run all checks : lint, test and docs.
cov Run coverage for generate report and html.
open-cov Open html coverage report in webbrowser.
docs Build documentation.
open-docs Open documentation in webbrowser.
setup Setup pre-commit.
pre-commit Run pre-commit.
clean Clean cache files
```
### Commit
If the linting is not successful, you can't commit.
For forcing the commit you can use the next command :
```bash
git commit --no-verify -m 'MESSAGE'
```
### How to add dependency
```bash
poetry add 'PACKAGE'
```
### Ignore illegitimate warnings
To ignore illegitimate warnings you can add :
- `# noqa: ERROR_CODE` on the same line for ruff.
- `# type: ignore[ERROR_CODE]` on the same line for mypy.
- `# pragma: no cover` on the same line to ignore line for coverage.
- `# doctest: +SKIP` on the same line for doctest.
## Uninstall
```bash
pip uninstall offline-translator
```
## License
This work is licensed under [MIT](https://github.com/Dashstrom/offline-translator/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/Dashstrom/offline-translator",
"name": "offline-translator",
"maintainer": "Dashstrom",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "dashstrom.pro@gmail.com",
"keywords": "python,translation,local,transformer,huggingface",
"author": "Dashstrom",
"author_email": "dashstrom.pro@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a5/83/b66656f4732b9b17a8a34616ace2d9ea18edeffd2edec6a5ec1564e902e1/offline_translator-0.0.2.tar.gz",
"platform": null,
"description": "# Offline Translator\n\n[](https://github.com/Dashstrom/offline-translator/actions/workflows/docs.yml)\n[](https://github.com/Dashstrom/offline-translator/actions/workflows/lint.yml)\n[](https://github.com/Dashstrom/offline-translator/actions/workflows/tests.yml)\n[](https://github.com/Dashstrom/offline-translator)\n[](https://pypi.org/project/offline-translator)\n[](https://static.pepy.tech/badge/offline-translator)\n[](https://github.com/Dashstrom/offline-translator/blob/main/LICENSE)\n\n## Description\n\nOffline Translator GUI using Opus-MT.\n\n## Installation\n\nFirst, you need to install [Python](https://www.python.org/downloads).\n\nThen you need to install `pipx` for install `offline-translator` as an application.\n\n```bash\n pip install pipx\n pipx ensurepath\n pipx install offline-translator\n offline-translator\n```\n\n## Development\n\n### Contributing\n\nContributions are very welcome. Tests can be run with `poe check`, please\nensure the coverage at least stays the same before you submit a pull request.\n\n### Setup\n\nYou need to install [Poetry](https://python-poetry.org/docs/#installation)\nand [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)\nfor work with this project.\n\n```bash\ngit clone https://github.com/Dashstrom/offline-translator\ncd offline-translator\npoetry install --all-extras\npoetry run poe setup\npoetry shell\n```\n\n### Poe\n\nPoe is available for help you to run tasks.\n\n```text\ntest Run test suite.\nlint Run linters : ruff linter, ruff formatter and mypy.\nformat Run linters in fix mode.\ncheck Run all checks : lint, test and docs.\ncov Run coverage for generate report and html.\nopen-cov Open html coverage report in webbrowser.\ndocs Build documentation.\nopen-docs Open documentation in webbrowser.\nsetup Setup pre-commit.\npre-commit Run pre-commit.\nclean Clean cache files\n```\n\n### Commit\n\nIf the linting is not successful, you can't commit.\nFor forcing the commit you can use the next command :\n\n```bash\ngit commit --no-verify -m 'MESSAGE'\n```\n\n### How to add dependency\n\n```bash\npoetry add 'PACKAGE'\n```\n\n### Ignore illegitimate warnings\n\nTo ignore illegitimate warnings you can add :\n\n- `# noqa: ERROR_CODE` on the same line for ruff.\n- `# type: ignore[ERROR_CODE]` on the same line for mypy.\n- `# pragma: no cover` on the same line to ignore line for coverage.\n- `# doctest: +SKIP` on the same line for doctest.\n\n## Uninstall\n\n```bash\npip uninstall offline-translator\n```\n\n## License\n\nThis work is licensed under [MIT](https://github.com/Dashstrom/offline-translator/blob/main/LICENSE).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Offline Translator GUI using Opus-MT.",
"version": "0.0.2",
"project_urls": {
"Documentation": "https://github.com/Dashstrom/offline-translator",
"Homepage": "https://github.com/Dashstrom/offline-translator",
"Repository": "https://github.com/Dashstrom/offline-translator"
},
"split_keywords": [
"python",
"translation",
"local",
"transformer",
"huggingface"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "13eee4f4eeb581c48eb2d2fecd55140234bfeeb2784e0f8d39c425ce0d2813d3",
"md5": "99ca904ef5f64364e86abf515e679e09",
"sha256": "a02d8b6a79f8b6aa730e5d5267b96c9ba1fdad084140883bbdfa576936455134"
},
"downloads": -1,
"filename": "offline_translator-0.0.2-cp38-cp38-manylinux_2_31_x86_64.whl",
"has_sig": false,
"md5_digest": "99ca904ef5f64364e86abf515e679e09",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.8",
"size": 148503,
"upload_time": "2024-02-19T19:47:09",
"upload_time_iso_8601": "2024-02-19T19:47:09.564423Z",
"url": "https://files.pythonhosted.org/packages/13/ee/e4f4eeb581c48eb2d2fecd55140234bfeeb2784e0f8d39c425ce0d2813d3/offline_translator-0.0.2-cp38-cp38-manylinux_2_31_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a583b66656f4732b9b17a8a34616ace2d9ea18edeffd2edec6a5ec1564e902e1",
"md5": "cd31e14498ea976b9de5cfae5491a032",
"sha256": "d420272c7bf7a1f743b1fd82ee797b64725ecf9f763da8650f06faed0b5feb81"
},
"downloads": -1,
"filename": "offline_translator-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "cd31e14498ea976b9de5cfae5491a032",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 150528,
"upload_time": "2024-02-19T19:47:10",
"upload_time_iso_8601": "2024-02-19T19:47:10.791908Z",
"url": "https://files.pythonhosted.org/packages/a5/83/b66656f4732b9b17a8a34616ace2d9ea18edeffd2edec6a5ec1564e902e1/offline_translator-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-19 19:47:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Dashstrom",
"github_project": "offline-translator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "offline-translator"
}
JSON
