[](https://codecov.io/gh/transifex/transifex-python)
# Transifex Python Toolkit
Transifex Python Toolkit is a collection of tools that allow you to easily localize your Django and Python applications using Transifex. The toolkit features fetching translations over the air (OTA) to your apps.
This project adheres to the Contributor Covenant [code of conduct](/CODE_OF_CONDUCT.md). To contribute to Transifex Python Toolkit, please check out the [contribution guidelines](/CONTRIBUTING.md).
# Upgrade to v2
If you are upgrading from the `1.x.x` version, please read this [migration guide](https://github.com/transifex/transifex-python/blob/HEAD/UPGRADE_TO_V2.md), as there are breaking changes in place.
# Quick starting guide
1. Install toolkit in your code `$ pip install transifex-python`
2. Add a provided TOKEN and SECRET in your config, connecting your application with a Transifex project
3. Add internationalization commands in your code
```HTML+Django
<!-- Django app template example -->
{% load transifex %}
<p>{% t "Hello!" %}</p>
<p>{% t "I want to be translated." %}</p>
```
```python
# Django view sample
from transifex.native.django import t
output = {
"msg1": t("Welcome aboard!"),
"msg2": t("It's great to have you here!"),
}
return JsonResponse(output)
```
4. Push strings to your connected Transifex project `./manage.py transifex push`
5. When translations are added in your Transifex project are automatically made available
To learn more about using Transifex Python toolkit check:
* [Quickstart guide for Django web application](https://developers.transifex.com/docs/django-sdk?utm_campaign=tx-native&utm_source=github&utm_medium=link)
* [Quickstart guide for Python application](https://developers.transifex.com/docs/python-sdk?utm_campaign=tx-native&utm_source=github&utm_medium=link)
* For a general overview visit [Transifex Native overview](https://developers.transifex.com/docs/native?utm_campaign=tx-native&utm_source=github&utm_medium=link)
* For some common questions & answers check our [Transifex Native community](https://community.transifex.com/c/transifex-native/17)
# License
Licensed under Apache License 2.0, see `LICENSE` file.
Raw data
{
"_id": null,
"home_page": "https://github.com/transifex/transifex-python",
"name": "transifex-python",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Transifex",
"author_email": "info@transifex.com",
"download_url": "https://files.pythonhosted.org/packages/cd/11/15792cc64ad1661b7db85a40b28e6b8b03b28a1dbe3f956b622eb55307fc/transifex-python-3.5.0.tar.gz",
"platform": null,
"description": "\n[](https://codecov.io/gh/transifex/transifex-python)\n\n# Transifex Python Toolkit\n\nTransifex Python Toolkit is a collection of tools that allow you to easily localize your Django and Python applications using Transifex. The toolkit features fetching translations over the air (OTA) to your apps.\n\nThis project adheres to the Contributor Covenant [code of conduct](/CODE_OF_CONDUCT.md). To contribute to Transifex Python Toolkit, please check out the [contribution guidelines](/CONTRIBUTING.md).\n\n# Upgrade to v2\n\nIf you are upgrading from the `1.x.x` version, please read this [migration guide](https://github.com/transifex/transifex-python/blob/HEAD/UPGRADE_TO_V2.md), as there are breaking changes in place.\n\n# Quick starting guide\n\n1. Install toolkit in your code `$ pip install transifex-python`\n2. Add a provided TOKEN and SECRET in your config, connecting your application with a Transifex project\n3. Add internationalization commands in your code\n```HTML+Django\n <!-- Django app template example -->\n\n {% load transifex %}\n <p>{% t \"Hello!\" %}</p>\n <p>{% t \"I want to be translated.\" %}</p>\n ```\n\n```python\n # Django view sample\n from transifex.native.django import t\n\n output = {\n \"msg1\": t(\"Welcome aboard!\"),\n \"msg2\": t(\"It's great to have you here!\"),\n }\n return JsonResponse(output)\n ```\n4. Push strings to your connected Transifex project `./manage.py transifex push`\n5. When translations are added in your Transifex project are automatically made available\n\nTo learn more about using Transifex Python toolkit check:\n* [Quickstart guide for Django web application](https://developers.transifex.com/docs/django-sdk?utm_campaign=tx-native&utm_source=github&utm_medium=link)\n* [Quickstart guide for Python application](https://developers.transifex.com/docs/python-sdk?utm_campaign=tx-native&utm_source=github&utm_medium=link)\n* For a general overview visit [Transifex Native overview](https://developers.transifex.com/docs/native?utm_campaign=tx-native&utm_source=github&utm_medium=link)\n* For some common questions & answers check our [Transifex Native community](https://community.transifex.com/c/transifex-native/17)\n\n# License\n\nLicensed under Apache License 2.0, see `LICENSE` file.",
"bugtrack_url": null,
"license": "",
"summary": "Transifex Python Toolkit",
"version": "3.5.0",
"project_urls": {
"Homepage": "https://github.com/transifex/transifex-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd1115792cc64ad1661b7db85a40b28e6b8b03b28a1dbe3f956b622eb55307fc",
"md5": "43c16c1b40bf008f982e915dbcf223cb",
"sha256": "a60d136774f27142f58f25507d45bef5ff9791554daae8ea7c23b625a917f4ef"
},
"downloads": -1,
"filename": "transifex-python-3.5.0.tar.gz",
"has_sig": false,
"md5_digest": "43c16c1b40bf008f982e915dbcf223cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 128997,
"upload_time": "2023-11-10T09:09:45",
"upload_time_iso_8601": "2023-11-10T09:09:45.987037Z",
"url": "https://files.pythonhosted.org/packages/cd/11/15792cc64ad1661b7db85a40b28e6b8b03b28a1dbe3f956b622eb55307fc/transifex-python-3.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-10 09:09:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "transifex",
"github_project": "transifex-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "transifex-python"
}
JSON
