Benvenuti nella documentazione di potDranslator!¶
Contenuto:
potranslator¶
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.
Opzionale: supporta il servizio collaborativo Transifex per caricare le traduzioni generate automaticamente in transifex per le correzioni collaborative delle traduzioni.
Lingue supportate¶
- Afrikaans af
- Sq. Albanese
- Amarico
- Arabo ar
- Armeno hy
- Az azero
- Eu basco
- Essere bielorusso
- Bn bengalese
- Bosniaco bs
- Bulgaro bg
- Catalano ca
- Cebuano ceb (ISO-639-2)
- Cinese (semplificato) zh-CN (BCP-47)
- Cinese (tradizionale) zh-TW (BCP-47)
- Co corso
- Croato
- Cs ceco
- Danese
- Nl olandesi
- Inglese en
- Esperanto eo
- Estone et
- Finlandese fi
- Francese
- Frisone
- Galiziano gl
- Ka georgiano
- Tedesco de
- El greco
- Gujarati gu
- Creolo haitiano ht
- Hausa ha
- Haw hawaiian (ISO-639-2)
- Iw ebraico
- Ciao Hindi
- Hmong hmn (ISO-639-2)
- Ungherese
- L’islandese è
- Igbo ig
- Id indonesiano
- Ga ga
- Italiano
- Giapponese ja
- Jw giavanese
- Kannada kn
- Kazako kk
- Khmer km
- Ko coreano
- Ku curdo
- Kyrgyz ky
- Lao lo
- La latina
- Lettone lv
- Lituano lt
- Lb lussemburghese
- Mk macedone
- Mg malgascio
- Ms malese
- Malayalam ml
- Maltese mt
- Maori mi
- Marathi signor
- Mn mongolo
- Myanmar (Birmano) mio
- Nepalese
- Norvegese no
- Nyanja (Chichewa), ny
- Pashto ps
- Fa persiano
- Polacco pl
- Portoghese (Portogallo, Brasile) pt
- Punjabi pa
- Rumeno ro
- Russo ru
- Samoano sm
- Gaelico scozzese gd
- Sr. Serbo
- Sesotho st
- Shona sn
- Sindhi sd
- Sinhala (singalese) si
- Slovacca sk
- Sloveno sl
- Somalo così
- Spagnolo es
- Sugherese
- Swahili sw
- Sv svedese
- Tagalog (filippino) tl
- Tagico tg
- Tamil ta
- Telugu te
- Th tailandese
- Turco tr
- Uk ucraino
- Urdu
- Uzbeko 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 è richiesto e` gettext_compact` è facoltativo.
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
Fatto. Hai queste directory che contengono file po con voci auto-tradotte:
./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
È tutto!
Caratteristiche di base¶
- Translate from pot files or update existing po files with auto-generated translation.
- Build mo files from translated po or pot files.
Requisiti per le funzionalità di base¶
- Python 3.6, 3.5, 3.4, 2.7, pypy.
- external libraries: setuptools, six, babel, click, googletrans, polib
Caratteristiche opzionali¶
Queste funzionalità richiedono la libreria 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.
- crea file mo da file po nella directory locale.
You need to use the tx command to use the following features:
- tx push -s: push pot (cataloghi di traduzione) su transifex.
- tx pull -l ja: pull po (cataloghi tradotti) da transifex.
Requisiti per le funzionalità opzionali¶
- Il tuo account transifex se vuoi caricare / scaricare file po da transifex.
- libreria esterna: transifex-client
Installazione¶
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]
Comandi, opzioni, variabili d’ambiente¶
comandi¶
Digita potranslator senza argomenti per mostrare le istruzioni di aiuto.
Imposta le variabili d’ambiente¶
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
Imposta 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
Imposta 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.
Licenza¶
Autorizzato con la licenza BSD. Vedere il file LICENSE per termini specifici.
Originale¶
The Command Line Interface and the transifex integration of potranslator are adapted from sphinx-intl.
I CAMBIAMENTI¶
See: https://github.com/SekouD/potranslator/blob/master/HISTORY.rst
Installazione¶
Rilascio stabile¶
Per installare il potranslator, esegui questo comando nel tuo terminale:
$ pip install potranslator
Questo è il metodo preferito per installare il potranslator, poiché installerà sempre la versione stabile più recente.
If you want to use the Optional Features, you need to install this additional library transifex-client:
$ pip install potranslator[transifex]
Se non hai installato pip, questa` Guida all’installazione di Python`_ può guidarti attraverso il processo.
Da fonti¶
Le fonti per il traduttrice possono essere scaricate dal Github repo.
È possibile clonare il repository pubblico:
$ git clone git://github.com/SekouD/potranslator
Oppure scarica il tarball:
$ curl -OL https://github.com/SekouD/potranslator/tarball/master
Una volta che hai una copia del codice sorgente, puoi installarlo con:
$ python setup.py install
uso¶
Da un programma 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)
Comandi, opzioni, variabili d’ambiente¶
comandi¶
Digita potranslator senza argomenti per mostrare le istruzioni di aiuto.
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!
Imposta le variabili d’ambiente¶
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
Imposta 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
Imposta 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.
Documentazione del pacchetto API per il potranslator¶
Riferimento API per le classi in potranslator.potranslator.py¶
Modulo principale
-
class
potranslator.potranslator.
PoTranslator
(pot_dir=None, locale_dir=None)[sorgente]¶ Questa è la classe principale di questa libreria. Questa classe gestisce tutte le attività di traduzione.
Parametri: - pot_dir – stringa. Percorso della directory del pot.
- locale_dir – stringa. Percorso della directory locale.
-
translate
(file_name, target_lang='auto', src_lang='auto', encoding='utf-8', auto_save=False, compiled=False)[sorgente]¶ Traduce il file po specificato nella lingua di destinazione specificata.
Parametri: - file_name – stringa. Percorso del nome file del file da tradurre.
- target_lang – stringa. Lingua di destinazione per la traduzione.
- src_lang – stringa. Lingua di partenza per la traduzione.
- encoding – stringa. Codifica per il salvataggio dei file po.
- auto_save – bool. Attiva / disattiva la funzione di salvataggio automatico.
- compiled – bool. Attiva / disattiva la compilazione in mo file.
Ritorna: tuple. Una tupla contenente la versione tradotta del catalogo originale e lo stato del POFile.
-
translate_all_locale
(src_lang='auto', encoding='utf-8', auto_save=False, compiled=False)[sorgente]¶ Traduce tutti i file po nelle lingue trovate nella cartella locale.
Parametri: - src_lang – stringa. Lingua di partenza per la traduzione.
- encoding – stringa. Codifica per il salvataggio dei file po.
- auto_save – bool. Attiva / disattiva la funzione di salvataggio automatico.
- compiled – bool. Attiva / disattiva la compilazione in mo file.
Ritorna: Dizionario. Un dizionario di file po.
-
translate_from_pot
(filename, status, target_langs, src_lang='auto', encoding='utf-8', auto_save=False, compiled=False)[sorgente]¶ Traduce il file pot specificato nelle lingue di destinazione specificate.
Parametri: - filename – stringa. Percorso del nome file del file da tradurre.
- target_langs – sequenza di stringhe. Lingua di destinazione per la traduzione.
- src_lang – stringa. Lingua di partenza per la traduzione.
- encoding – stringa. Codifica per il salvataggio dei file po.
- auto_save – bool. Attiva / disattiva la funzione di salvataggio automatico.
- compiled – bool. Attiva / disattiva la compilazione in mo file.
Ritorna: Dizionario. Un dizionario di file po.
-
translate_all_pot
(target_langs, src_lang='auto', encoding='utf-8', auto_save=False, compiled=False)[sorgente]¶ Traduce tutti i file pot nella cartella pot nelle lingue di destinazione specificate.
Parametri: - target_langs – sequenza di stringhe. Lingua di destinazione per la traduzione.
- src_lang – stringa. Lingua di partenza per la traduzione.
- encoding – stringa. Codifica per il salvataggio dei file po.
- auto_save – bool. Attiva / disattiva la funzione di salvataggio automatico.
- compiled – bool. Attiva / disattiva la compilazione in mo file.
Ritorna: Dizionario. Un dizionario di file po.
contribuire¶
I contributi sono ben accetti e sono molto apprezzati! Ogni piccolo aiuto e il credito sarà sempre dato.
Puoi contribuire in molti modi:
Tipi di contributi¶
Segnala bug¶
Segnala bug all’indirizzo https://github.com/SekouD/potranslator/issues.
Se stai segnalando un bug, includi:
- Nome e versione del tuo sistema operativo.
- Qualsiasi dettaglio sulla configurazione locale che potrebbe essere utile nella risoluzione dei problemi.
- Passaggi dettagliati per riprodurre il bug.
Correggere i bug¶
Guarda i problemi di GitHub per i bug. Qualunque taggato con «bug» e «help wanted» è aperto a chiunque voglia implementarlo.
Implementare caratteristiche¶
Esamina i problemi di GitHub per le funzionalità. Qualsiasi cosa taggata con «miglioramento» e «richiesta di aiuto» è aperta a chiunque voglia implementarla.
Scrivi documentazione¶
il traduttrice potrebbe sempre usare più documentazione, sia come parte dei documenti ufficiali di traduttori, in docstrings, o anche sul web in post di blog, articoli e simili.
Invia feedback¶
Il modo migliore per inviare feedback è presentare un problema all’indirizzo https://github.com/SekouD/potranslator/issues.
Se stai proponendo una funzione:
- Spiega in dettaglio come funzionerebbe.
- Mantenere l’ambito il più stretto possibile, per renderlo più facile da implementare.
- Ricorda che questo è un progetto guidato dai volontari e che i contributi sono benvenuti :)
Iniziare!¶
Pronto a contribuire? Ecco come impostare potranslator per lo sviluppo locale.
Forchetta il repo potranslator su GitHub.
Clona la tua forcella localmente
$ git clone git@github.com:your_name_here/potranslator.git
Installa la tua copia locale in un virtualenv. Supponendo di aver installato virtualenvwrapper, questo è il modo in cui imposti la tua forcella per lo sviluppo locale
$ mkvirtualenv potranslator $ cd potranslator/ $ python setup.py develop
Crea un ramo per lo sviluppo locale
$ git checkout -b name-of-your-bugfix-or-feature
Ora puoi apportare le modifiche a livello locale.
Quando hai terminato le modifiche, verifica che le tue modifiche superino flake8 e i test, incluso testare altre versioni di Python con tox
$ flake8 potranslator tests $ python setup.py test or py.test $ tox
Per ottenere flake8 e tox, basta installarli nel tuo virtualenv.
Confida le tue modifiche e invia il tuo ramo a GitHub
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Invia una richiesta di pull tramite il sito Web GitHub.
Pull Request Guidelines¶
Prima di inviare una richiesta di pull, controlla che soddisfi le seguenti linee guida:
- La richiesta di pull dovrebbe includere test.
- Se la richiesta pull aggiunge funzionalità, i documenti dovrebbero essere aggiornati. Metti la tua nuova funzionalità in una funzione con una docstring e aggiungi la funzione alla lista in README.rst.
- La richiesta pull dovrebbe funzionare per Python 2.7, 3.4, 3.5 e 3.6 e per PyPy. Controlla https://travis-ci.org/SekouD/potranslator/pull_requests e assicurati che i test superino tutte le versioni di Python supportate.
Distribuzione¶
Un promemoria per i manutentori su come distribuire. Assicurati che tutte le modifiche siano state confermate (inclusa una voce in HISTORY.rst). Quindi eseguire
$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags
Travis verrà quindi distribuito su PyPI se i test supereranno.
Crediti¶
Lead di sviluppo¶
- SekouD <sekoud.python@gmail.com> GPG key ID: B51D1046EF63C50B
Contributori¶
Nessuno ancora. Perché non essere il primo?
Storia¶
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)¶
- Primo rilascio candidato.
- Aggiunto Command Line Interface.
0.1.0 (2018-06-27)¶
- Prima versione su PyPI.
Indici e tabelle¶
- : ref: genindex
- : Ref: modindex
- : Ref: search
\ Sort by:\ best rated\ newest\ oldest\
\\
Add a comment\ (markup):
\``code``
, \ code blocks:::
and an indented block after blank line