Metadata-Version: 2.1
Name: interactions-i18n
Version: 0.0.2
Summary: Add localization support to your interactions.py bot
Home-page: https://github.com/Damego/interactions-i18n
Author: Damego
Author-email: damego.dev@gmail.com
License: MIT License
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Python: >=3.8.6
Description-Content-Type: text/markdown
License-File: LICENSE

# interactions-i18n
Add localization support to your interactions.py bot

## Installation

`pip install --upgrade interactions-i18n`

## Usage

```py
import interactions
from interactions.ext.i18n import setup

client = interactions.Client(...)

# Load an i18n extension
i18n = setup(client)
# Load a folder with locales
# Also you can load json file only
i18n.load("./locales/")

...

client.start()
```

## Creating a locale file

1. Choose a language you want and find their code in the [Discord Locales Docs](https://discord.com/developers/docs/reference#locales)
2. Create a `[CODE].json` file with found code in the folder with locales.

## Getting and setting keys

Let's create a command with name `info` with some subcommands

```py
@client.command()
async def info(ctx: interactions.CommandContext):
    ...
    # Key for command name will be `INFO_NAME`
    # Key for command description will be `INFO_DESCRIPTION`


@info.group()
async def my_group(ctx: interactions.CommandContext):
    ...
    # Keys are `MY_GROUP_NAME` for name and `MY_GROUP_DESCRIPTION` for description


@my_group.subcommand()
@interactions.option(key="info_member_opt")  # `key` is optional. Keys for this option you can get from option name
async def user(ctx: interactions.CommandContext, member: interactions.Member):
    ...
    # Keys for subcommand are `USER_NAME` for name and `USER_DESCRIPTION` for description
    # Keys for option are `INFO_MEMBER_OPT_NAME` for name and `INFO_MEMBER_OPT_DESCRIPTION` for description
```

How will look our json file

`locales/de.json`

```json
{
  "INFO_NAME": "...",
  "INFO_DESCRIPTION": "...",
  "MY_GROUP_NAME": "...",
  "MY_GROUP_DESCRIPTION": "...",
  "MEMBER_NAME": "...",
  "MEMBER_DESCRIPTION": "...",
  "INFO_MEMBER_OPT_NAME": "...",
  "INFO_MEMBER_OPT_DESCRIPTION": "..."
}
```

### Usage in Extension's

```py
from interactions import Extension
from interactions.ext.i18n import Localization


class MyExt(Extension):
    def __init__(self, client):
        self.client = client

        self.i18n: Localization = self.client.i18n
```
