Metadata-Version: 2.1
Name: simplebot-translator
Version: 1.4.1
Summary: 🌎 Translator plugin for SimpleBot
Home-page: https://github.com/adbenitez/simplebot_translator
Author: adbenitez
Author-email: adbenitez@nauta.cu
License: MPL
Keywords: simplebot plugin deltachat
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Plugins
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Utilities
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: simplebot >=4.0.0
Requires-Dist: translators >=5.4.2
Provides-Extra: dev
Requires-Dist: simplebot >=4.0.0 ; extra == 'dev'
Requires-Dist: translators >=5.4.2 ; extra == 'dev'
Requires-Dist: pytest >=7.1.2 ; extra == 'dev'
Requires-Dist: black >=22.10.0 ; extra == 'dev'
Requires-Dist: mypy >=0.982 ; extra == 'dev'
Requires-Dist: isort >=5.10.1 ; extra == 'dev'
Requires-Dist: pylint >=2.15.3 ; extra == 'dev'
Requires-Dist: pylama >=8.3.8 ; extra == 'dev'
Requires-Dist: types-pkg-resources >=0.1.3 ; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest >=7.1.2 ; extra == 'test'

Translator
==========

.. image:: https://img.shields.io/pypi/v/simplebot_translator.svg
   :target: https://pypi.org/project/simplebot_translator

.. image:: https://img.shields.io/pypi/pyversions/simplebot_translator.svg
   :target: https://pypi.org/project/simplebot_translator

.. image:: https://pepy.tech/badge/simplebot_translator
   :target: https://pepy.tech/project/simplebot_translator

.. image:: https://img.shields.io/pypi/l/simplebot_translator.svg
   :target: https://pypi.org/project/simplebot_translator

.. image:: https://github.com/adbenitez/simplebot_translator/actions/workflows/python-ci.yml/badge.svg
   :target: https://github.com/adbenitez/simplebot_translator/actions/workflows/python-ci.yml

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black

🌎 Translator plugin for `SimpleBot`_.

This plugin registers the ``/tr`` command that end-users can use to
translate text. Example: ``/tr en es hello world``.

Install
-------

To install run::

  pip install simplebot-translator

To configure default engine use::

  simplebot db -s simplebot_translator/engine deepl

To configure default language used in filter use::

  simplebot db -s global/language en


To disable the default filter and only allow to translate with commands::

  simplebot db -s global/filter_enabled no

You may need to install other dependencies to make some engines work, check: https://github.com/UlionTse/translators

Available engines
-----------------

- google
- yandex
- bing
- sogou
- baidu
- tencent
- youdao
- alibaba
- deepl

.. _SimpleBot: https://github.com/simplebot-org/simplebot
