Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dorukyum/pycord-i18n
Easy internationalization for pycord
https://github.com/dorukyum/pycord-i18n
i18n internationalization pycord
Last synced: 22 days ago
JSON representation
Easy internationalization for pycord
- Host: GitHub
- URL: https://github.com/dorukyum/pycord-i18n
- Owner: Dorukyum
- License: mit
- Created: 2022-09-03T09:53:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-08T05:53:35.000Z (8 months ago)
- Last Synced: 2024-10-13T18:59:19.701Z (24 days ago)
- Topics: i18n, internationalization, pycord
- Language: Python
- Homepage: https://discord.gg/8JsMVhBP4W
- Size: 14.6 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
pycord-i18n
Internationalization for Pycord
## Key Features
- Translated responses
- Command name, description & option localization
- Based on user & server locale (no need for storage!)
## Installation
To install this extension, run the corresponding command:
```sh
# linux / macOS
python3 -m pip install pycord-i18n
# windows
python -m pip install pycord-i18n
```
## Usage
1. Setup your internationalization files just like [sample-german.json](https://github.com/Dorukyum/pycord-i18n/blob/main/sample-german.json).
Note that **all fields are optional** and **you can use whichever file format you want** as long as you pass the translations into I18n in the given format.
2. Load your files:
```py
import json
with open("sample-german.json", "r") as f:
german = json.load(f)
...
```
3. Create an I18n object:
```py
from pycord.i18n import I18n, _
i18n = I18n(bot, de=german)
# de is the locale code for German
# response translations will be based on the guild's locale, you can make the bot consider the user's locale too by using the following:
i18n = I18n(bot, consider_user_locale=True, de=german)
# all valid locales: da, de, en_GB, en_US, es_ES, fr, hr, it, lt, hu, nl, no, pl, pt_BR, ro, fi, sv_SE, vi, tr, cs, el, bg, ru, uk, hi, th, zh_CN, ja, zh_TW, ko
```
4. Internationalize your commands:
```py
@i18n.localize # command name and description localization
@bot.slash_command()
async def hello(ctx):
await ctx.respond(_("Hello, this sentence is in English"))
# "_()" does the translation
# if you don't want to use `@localize` on every command, simply use the following method after adding the commands to the bot:
i18n.localize_commands()
```
## Changelog
### v1.2.1
- Fixed an issue with Pycord v2.5 compatibility
### v1.2.0
- Added formatting support
### v1.1.0
- Added option localization support