yet-another-i18n 0.2.0
A lightweight and developer-friendly Python translation library designed for simplicity and flexibility.
License: MIT
Requires Python: >=3.8
Keywords: i18n, json, localization, translation

# yet another i18n

A lightweight and developer-friendly Python translation library designed for simplicity and flexibility.

## Features

- 🌐 json-based translation: easy-to-use translations powered by simple JSON files.
- 🔄 fallback language support: automatically provides translations in a fallback language when a specific translation is unavailable.
- 🧩 nested values and placeholders: fully supports nested structures and dynamic placeholders within translations.
- 🎛️ flexible translation styles: offers both preconfigured translations and on-the-fly translation generation.
- 🛠️ developer experience focused api: designed with developers in mind, drawing inspiration from other projects.
- ⚡ lightweight and simple: under 150 lines of code with no dependencies beyond Python's standard library.

## Usage

### 0. Installation

Install the package via pip:

```bash
pip install yet-another-i18n
```

### 1. Initialization

Create a `Translator` instance by specifying at least the fallback locale.

```python
from yai18n import Translator

translator = Translator(
    fallback_locale="en",
)
```

- **fallback_locale** (required): The locale to use if the requested key is not found in any other locale.
- **default_locale** (optional): The primary locale used when none is explicitly provided.
- **locale_folder_path** (optional): Directory containing your JSON locale files. (default: `"locales"`)
- **debug** (optional): If `True`, locale files are reloaded before each translation (useful for development).

### 2. Locale Files

Each locale file should be a JSON file named `<locale>.json` within the specified `locale_folder_path`. Example:

`en.json`:

```json
{
  "greeting": {
    "hello": "Hello, {name}!"
  }
}
```

### 3. Translation

To translate a key, simply call the `Translator` instance:

```python
message = translator("greeting.hello", locale="en", args={"name": "Alice"})
print(message)  # Outputs: "Hello, Alice!"
```

- **key**: A string path (e.g., `"section.subsection.key"`) to the translated text.
- **locale** (optional): Override the default locale for this translation.
- **args** (optional): A dictionary to format dynamic placeholders in the translated text.

### 4. Fallback Behavior

If a key does not exist in the requested locale, the translator automatically uses the `fallback_locale`.
If the key is not found there either, a `KeyError` is raised.

### 5. Error Handling

- **ValueError**: Raised if a requested locale or default locale is not found.
- **TypeError**: Raised if arguments to methods are of incorrect types.
- **KeyError**: Raised if a translation key cannot be found in both the given and fallback locales.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/2mal3"><img src="https://avatars.githubusercontent.com/u/56305732?v=4?s=100" width="100px;" alt="2mal3"/><br /><sub><b>2mal3</b></sub></a><br /><a href="https://github.com/2mal3/yet-another-i18n/commits?author=2mal3" title="Code">💻</a> <a href="https://github.com/2mal3/yet-another-i18n/commits?author=2mal3" title="Documentation">📖</a> <a href="#platform-2mal3" title="Packaging/porting to new platform">📦</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/LuisSchuimer"><img src="https://avatars.githubusercontent.com/u/85784931?v=4?s=100" width="100px;" alt="Luis Schuimer"/><br /><sub><b>Luis Schuimer</b></sub></a><br /><a href="https://github.com/2mal3/yet-another-i18n/issues?q=author%3ALuisSchuimer" title="Bug reports">🐛</a> <a href="#userTesting-LuisSchuimer" title="User Testing">📓</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!