Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thegamecracks/discord.py-i18n-demo
A guide to internationalization with Python and discord.py.
https://github.com/thegamecracks/discord.py-i18n-demo
discord-py gettext i18n l10n python python-package tutorial
Last synced: about 3 hours ago
JSON representation
A guide to internationalization with Python and discord.py.
- Host: GitHub
- URL: https://github.com/thegamecracks/discord.py-i18n-demo
- Owner: thegamecracks
- License: mit
- Created: 2023-07-21T05:23:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-16T17:34:41.000Z (2 days ago)
- Last Synced: 2024-11-16T18:26:08.455Z (2 days ago)
- Topics: discord-py, gettext, i18n, l10n, python, python-package, tutorial
- Language: Python
- Homepage:
- Size: 214 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# discord.py-i18n-demo
This project demonstrates how to set up gettext localization and integrate it
into discord.py v2.0.
Check out the [onboarding] if you want to learn how gettext and the package works.
If you just want to test out the package, then:
1. Install this repository
```sh
python -m pip install git+https://github.com/thegamecracks/discord.py-i18n-demo
```
2. Create a [config.toml] file with your bot token
```toml
[bot]
token = "Bot token from https://discord.com/developers/applications"
```
3. Start the bot
```sh
python -m dpygt
```
4. Use the "<@mention> sync" text command to register application commands
## Requirements
- Python 3.11 or greater
- `gettext` and its associated utilities, particularly `msgfmt`
- Not sure how to get this? See the [onboarding](/docs/en/onboarding.md#gettext)
## Alternatives
discord.py can be used with any translation library, not just gettext.
If you are interested in alternatives, consider using [Project Fluent]
via the [fluent-compiler] package which provides more comprehensive
localization features such as arbitrarily-defined message variants,
message cross-references, and automatic numeric/datetime formatting
(see also [Fluent vs. gettext]).
## Contributing
Want to add translations? [Fork this repository], create a new branch,
commit your changes there, then make a pull request. You may want to
read the [onboarding] to learn how localizations are done, or look at
how [existing localizations](/src/dpygt/locales/) are written.
[onboarding]: /docs/en/onboarding.md
[config.toml]: /src/dpygt/config_default.toml
[Project Fluent]: https://projectfluent.org/
[fluent-compiler]: https://fluent-compiler.readthedocs.io/en/latest/
[Fluent vs. gettext]: https://github.com/projectfluent/fluent/wiki/Fluent-vs-gettext
[Fork this repository]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects