Bienvenido a la documentación de potraslator!¶

Contenido:

potracionador¶

potranslator is a package to easily translate po and pot files generated by Sphinx or other tools in any language supported by Google Translate.

potranslator auto-detects the language in the original pot files and auto-translates the pot files into the supplied target languages.

The Command Line Interface of potranslator and its documentation are based on sphinx-intl.

Opcional: admite el servicio colaborativo Transifex para cargar las traducciones generadas automáticamente a transifex para correcciones colaborativas de las traducciones.

Idiomas admitidos¶

Afrikaans af
Cuadrado albanés
Amárico am
Arárabe
Hy armenio
Az azerbaiyano
Euskara
Bielorruso sea
Bengalí bn
Bosnio bs
Bg búlgaro
Catalán ca
Ceb Cebuano (ISO-639-2)
Chino (simplificado) zh-CN (BCP-47)
Chino (tradicional) zh-TW (BCP-47)
Corsican co
Hora croata
Checo cs
Danés da
Holandés nl
Inglés en
Esperanto eo
Estonio et
Finlandés fi
Franco francés
Frisian fy
Gl Gallego
Ka georgiano
Alemán de
El griego
Gujarati gu
Criollo haitiano ht
Hausa ha
Haw hawaiano (ISO-639-2)
Hebreo iw
Hindi hola
Hmong hmn (ISO-639-2)
Húngaro hu
Islandés es
Igbo ig
ID indonesio
Ga irlandés
Italiano
Ja japonesa
Javanés jw
Kannada kn
Kazajo kk
Km Khmer
Ko coreano
Kurdo ku
Kyrgyz ky
Lao lo
La Latina
Letón lv
Lituano lt
Libra Luxemburguesa
Macedonio mk
Mg malgache
Malay ms
Malayalam ml
Malta mt
Maori mi
Marathi mr
Mongol mn
Myanmar (Birmano) mi
Nepali ne
Noruego no
Nyanja (Chichewa) ny
Pashto ps
Fa persa
Polaco f pl
Portugués (Portugal, Brasil) pt
Punjabi pa
Rumano
Ru ruso
Samoan sm
Scots Gaelic gd
Serbio sr
Sesotho st
Shona sn
Sindhi sd
Sinhala (Sinhalese) si
Eslovaco sk
Esloveno sl
Somalí entonces
Español es
Sundanese su
Swahili sw
Sv sueco
Tagalo (filipino) tl
Tajik tg
Tamil ta
Telugu te
Th tailandés
Turco tr
Uk ucraniano
Urdu ur
Uz uz
Vietnamita vi
Welsh cy
Xhosa xh
Yiddish yi
Yoruba yo
Zulu zu

Quick Start for auto-translation with potranslator¶

This section describes how to translate documents generated by Sphinx with the potranslator command.

Create your document(s) by using Sphinx:

$ sphinx-build -b html /path/to/docs path/to/docs/_build

Optionally add the settings to your conf.py if you have one:

locale_dirs = ['locale/']   #path is an example but this is the recommended path.
gettext_compact = False     #optional.

locale_dirs es obligatorio y` gettext_compact` es opcional.

Extract the document’s translatable messages into pot files (make sure you are in the folder containing make.bat and Makefile if you are on windows):
$ make gettext
Translate/Update your documents in German and Japanese:
$ potranslator update -p _build/gettext -l de -l ja
Hecho. Obtuvo estos directorios que contienen archivos po con entradas traducidas automáticamente:
```
./locale/de/LC_MESSAGES/
./locale/ja/LC_MESSAGES/
```

Translate/Update your documents in Japanese, build the compiled mo files and generate the translated html documents:

Command line (for Unix systems):

$ potranslator build
$ make -e SPHINXOPTS="-D language='ja'" html

Command line (for Windows cmd.exe):

> set SPHINXOPTS=-D language=de
> potranslator build
> .\make.bat html

Command line (for PowerShell):

> Set-Item env:SPHINXOPTS "-D language=de"
> potranslator build
> .\make.bat html

¡Eso es todo!

Caracteristicas basicas¶

Translate from pot files or update existing po files with auto-generated translation.
Build mo files from translated po or pot files.

Requisitos para las características básicas¶

Python 3.6, 3.5, 3.4, 2.7, pypy.
external libraries: setuptools, six, babel, click, googletrans, polib

Características opcionales¶

Estas características necesitan la biblioteca transifex-client.

create a .transifexrc file from an environment variable, without interactive input.
create a .tx/config file without interactive input.
update a .tx/config file from locale/pot files automatically.
compilar archivos mo desde archivos po en el directorio de configuración regional.

You need to use the tx command to use the following features:

tx push -s: push pot (catálogos de traducción) a transifex.
tx pull -l ja: pull po (catálogos traducidos) de transifex.

Requisitos para las características opcionales¶

Su cuenta transifex si desea cargar / descargar archivos po de transifex.
biblioteca externa: transifex-client

Instalación¶

It is strongly recommended to use virtualenv for this procedure:

$ pip install potranslator

If you want to use the Optional Features, you need install this additional library:

$ pip install potranslator[transifex]

Comandos, opciones, variables de entorno¶

Comandos¶

Escriba potraslator sin argumentos para mostrar las instrucciones de ayuda.

Configurar variables de entorno¶

All command-line options can be set with environment variables using the format POTRANSLATOR_<UPPER_LONG_NAME> .

Dashes (-) have to replaced with underscores (_).

For example, to set the target languages:

$ export POTRANSLATOR_LANGUAGE=de,ja

On the Windows command line:

> set POTRANSLATOR_LANGUAGE=de,ja

This is the same as passing the option to potranslator directly:

$ potranslator <command> --language=de --language=ja

Configuración sphinx conf.py¶

Add the following settings to your sphinx document’s conf.py if it exists:

locale_dirs = ['locale/']   #for example
gettext_compact = False     #optional

Configurar Makefile / make.bat¶

make gettext will generate pot files into the _build/gettext directory, however pot files can be generated in the locale/pot directory if convenient.

You can do that by replacing _build/gettext with locale/pot in your Makefile and/or make.bat that was generated by sphinx-quickstart.

Licencia¶

Licencia bajo la licencia BSD. Consulte el archivo LICENCIA para conocer los términos específicos.

Original¶

The Command Line Interface and the transifex integration of potranslator are adapted from sphinx-intl.

https://pypi.org/project/sphinx-intl

CAMBIOS¶

See: https://github.com/SekouD/potranslator/blob/master/HISTORY.rst

Instalación¶

Lanzamiento estable¶

Para instalar potraSlator, ejecute este comando en su terminal:

$ pip install potranslator

Este es el método preferido para instalar potraSlator, ya que siempre instalará la versión estable más reciente.

If you want to use the Optional Features, you need to install this additional library transifex-client:

$ pip install potranslator[transifex]

Si no tiene pip instalado, esta` guía de instalación de Python`_ puede guiarlo en el proceso.

De fuentes¶

Las fuentes de potranslator se pueden descargar del Github repo.

Puedes clonar el repositorio público:

$ git clone git://github.com/SekouD/potranslator

O descargue el tarball:

$ curl  -OL https://github.com/SekouD/potranslator/tarball/master

Una vez que tenga una copia de la fuente, puede instalarla con:

$ python setup.py install

Uso¶

Desde un programa de Python¶

To use potranslator in a python project:

from potranslator import PoTranslator

languages = ('fr', 'es', 'it')
translator = PoTranslator(pot_dir='path/to/pot_dir', locale_dir='path/to/locale_dir')

results = translator.translate_all_pot(src_lang='en', target_langs=languages, auto_save=False)

Comandos, opciones, variables de entorno¶

Comandos¶

Escriba potraslator sin argumentos para mostrar las instrucciones de ayuda.

Basic Usage¶

This section describes how to translate documents generated by Sphinx with the potranslator command.

Create your document(s) by using Sphinx:

$ sphinx-build -b html /path/to/docs path/to/docs/_build

Optionally add the settings to your conf.py if you have one:

locale_dirs = ['locale/']   #path is an example but this is the recommended path.
gettext_compact = False     #optional.

locale_dirs is required and gettext_compact is optional.

Extract the document’s translatable messages into pot files (make sure you are in the folder containing make.bat and Makefile if you are on windows):
$ make gettext
Translate/Update your documents in German and Japanese:
$ potranslator update -p _build/gettext -l de -l ja
Done. You got these directories that contain po files with auto-translated entries:
```
./locale/de/LC_MESSAGES/
./locale/ja/LC_MESSAGES/
```

Translate/Update your documents in Japanese, build the compiled mo files and generate the translated html documents:

Command line (for Unix systems):

$ potranslator build
$ make -e SPHINXOPTS="-D language='ja'" html

Command line (for Windows cmd.exe):

> set SPHINXOPTS=-D language=de
> potranslator build
> .\make.bat html

Command line (for PowerShell):

> Set-Item env:SPHINXOPTS "-D language=de"
> potranslator build
> .\make.bat html

That’s all!

Configurar variables de entorno¶

All command-line options can be set with environment variables using the format POTRANSLATOR_<UPPER_LONG_NAME> .

Dashes (-) have to replaced with underscores (_).

For example, to set the languages:

$ export POTRANSLATOR_LANGUAGE=de,ja

On the Windows command line:

> set POTRANSLATOR_LANGUAGE=de,ja

This is the same as passing the option to potranslator directly:

$ potranslator <command> --language=de --language=ja

Configuración sphinx conf.py¶

Add the following settings to your sphinx document’s conf.py if it exists:

locale_dirs = ['locale/']   #for example
gettext_compact = False     #optional

Configurar Makefile / make.bat¶

make gettext will generate pot files into _build/gettext directory, however pot files can be generated in the locale/pot if convenient.

You can do that by replacing _build/gettext with locale/pot in your Makefile and/or make.bat that was generated by sphinx-quickstart.

Package Api Documentation for potraslator¶

Referencia de API para las clases en potranslator.potranslator.py¶

Módulo principal.

class potranslator.potranslator.PoTranslator(pot_dir=None, locale_dir=None)[fuente]¶

Esta es la clase principal de esta biblioteca. Esta clase maneja todas las tareas de traducción.

Parámetros:	pot_dir – cuerda. Camino al directorio de la olla. locale_dir – cuerda. Ruta al directorio de locale

translate(file_name, target_lang='auto', src_lang='auto', encoding='utf-8', auto_save=False, compiled=False)[fuente]¶

Traduce el archivo po dado en el idioma de destino especificado.

Parámetros:

file_name – cuerda. Ruta al nombre de archivo del archivo a traducir.
target_lang – cuerda. Idioma de destino para la traducción.
src_lang – cuerda. Idioma de origen para la traducción.
encoding – cuerda. Codificación para guardar los archivos po.
auto_save – bool. Alterna la función de guardar automáticamente.
compiled – bool. Alterna la compilación a archivos mo.

Devuelve:

tupla Una tupla que contiene la versión traducida del catálogo original y el estado de POFile.

translate_all_locale(src_lang='auto', encoding='utf-8', auto_save=False, compiled=False)[fuente]¶

Traduce todos los archivos po en los idiomas encontrados en la carpeta de configuración regional.

Parámetros:	src_lang – cuerda. Idioma de origen para la traducción. encoding – cuerda. Codificación para guardar los archivos po. auto_save – bool. Alterna la función de guardar automáticamente. compiled – bool. Alterna la compilación a archivos mo.
Devuelve:	Diccionario. Un diccionario de archivos po.

translate_from_pot(filename, status, target_langs, src_lang='auto', encoding='utf-8', auto_save=False, compiled=False)[fuente]¶

Traduce el archivo pot dado en los idiomas de destino especificados.

Parámetros:

filename – cuerda. Ruta al nombre de archivo del archivo a traducir.
target_langs – secuencia de cadenas. Idioma de destino para la traducción.
src_lang – cuerda. Idioma de origen para la traducción.
encoding – cuerda. Codificación para guardar los archivos po.
auto_save – bool. Alterna la función de guardar automáticamente.
compiled – bool. Alterna la compilación a archivos mo.

Devuelve:

Diccionario. Un diccionario de archivos po.

translate_all_pot(target_langs, src_lang='auto', encoding='utf-8', auto_save=False, compiled=False)[fuente]¶

Traduce todos los archivos pot en la carpeta pot en los idiomas de destino especificados.

Parámetros:	target_langs – secuencia de cadenas. Idioma de destino para la traducción. src_lang – cuerda. Idioma de origen para la traducción. encoding – cuerda. Codificación para guardar los archivos po. auto_save – bool. Alterna la función de guardar automáticamente. compiled – bool. Alterna la compilación a archivos mo.
Devuelve:	Diccionario. Un diccionario de archivos po.

Contribuyendo¶

¡Las contribuciones son bienvenidas, y son muy apreciadas! Todo ayuda, y el crédito siempre se dará.

Puedes contribuir de muchas maneras:

Tipos de contribuciones¶

Reportar errores¶

Informar errores en https://github.com/SekouD/potranslator/issues.

Si informa un error, incluya lo siguiente:

El nombre y la versión de su sistema operativo.
Cualquier detalle sobre su configuración local que pueda ser útil para solucionar problemas.
Pasos detallados para reproducir el error.

Corregir errores¶

Consulte los problemas de GitHub para encontrar errores. Cualquier cosa etiquetada con «error» y «ayuda querida» está abierta para quien quiera implementarla.

Implementar funciones¶

Consulte los problemas de GitHub para conocer las características. Cualquier cosa etiquetada con «mejora» y «ayuda deseada» está abierta para quien quiera implementarla.

Escribir documentación¶

potraslador siempre podría usar más documentación, ya sea como parte de los documentos oficiales de potracionador, en documentos, o incluso en la web en publicaciones de blogs, artículos y demás.

Enviar comentarios¶

La mejor forma de enviar comentarios es presentar un problema en https://github.com/SekouD/potranslator/issues.

Si está proponiendo una función:

Explica en detalle cómo funcionaría.
Mantenga el alcance lo más estrecho posible, para que sea más fácil de implementar.
Recuerde que este es un proyecto impulsado por voluntarios, y que las contribuciones son bienvenidas :)

¡Empezar!¶

Listo para contribuir? A continuación se explica cómo configurar el potrasador para el desarrollo local.

Tenedor el repositorio potraslator en GitHub.

Clona tu tenedor localmente

$ git clone git@github.com:your_name_here/potranslator.git

Instale su copia local en un virtualenv. Suponiendo que tiene virtualenvwrapper instalado, así es como configura su tenedor para el desarrollo local
```
$ mkvirtualenv potranslator
$ cd potranslator/
$ python setup.py develop
```
Crear una rama para el desarrollo local
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Ahora puedes hacer tus cambios localmente.
Cuando hayas terminado de hacer cambios, comprueba que tus cambios pasen a flake8 y a las pruebas, incluida la prueba de otras versiones de Python con tox
```
$ flake8 potranslator tests
$ python setup.py test or py.test
$ tox
```
Para obtener Flake8 y tox, simplemente pip instálelos en su Virtualenv.

Confirme sus cambios y envíe su sucursal a GitHub

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Presente una solicitud de extracción a través del sitio web de GitHub.

Pautas de solicitud de extracción¶

Antes de enviar una solicitud de extracción, verifique que cumpla con estas pautas:

La solicitud de extracción debe incluir pruebas.
Si la solicitud de extracción agrega funcionalidad, los documentos deberían actualizarse. Ponga su nueva funcionalidad en una función con una docstring, y agregue la característica a la lista en README.rst.
La solicitud de extracción debería funcionar para Python 2.7, 3.4, 3.5 y 3.6, y para PyPy. Verifique https://travis-ci.org/SekouD/potranslator/pull_requests y asegúrese de que las pruebas se aprueben para todas las versiones compatibles de Python.

Consejos¶

Para ejecutar un subconjunto de pruebas

$ py.test tests.test_potranslator

Despliegue¶

Un recordatorio para los mantenedores sobre cómo implementar. Asegúrese de que se hayan confirmado todos sus cambios (incluida una entrada en HISTORY.rst). Entonces corre:

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis luego se desplegará en PyPI si pasan las pruebas.

Créditos¶

Líder de desarrollo¶

SekouD <sekoud.python@gmail.com> GPG key ID: B51D1046EF63C50B

Colaboradores¶

Ninguna todavia. Por que no ser el primero?

Historia¶

1.1.0 (2018-07-08)¶

Now uses importlib_ressources for faster startup from CLI.
Updated the command line usability.
Added Type Annotation compliant with PEP 561.
Updated Documentation.

1.0.5 (2018-07-06)¶

Updated Documentation.
Translated the documentation in French, Spanish, Italian, German, Italian, Japanese and Chinese.
More detailed updates to the po files meta-data.

1.0.0 (2018-07-05)¶

Primera versión candidata.
Interfaz de línea de comando agregada.

0.1.0 (2018-06-27)¶

Primer lanzamiento en PyPI.

Índices y tablas¶

: ref: genindex
: ref: modindex
: ref: búsqueda