pyi18t-tools 0.6.0__tar.gz

pyi18t_tools-0.6.0/.gitignore

@@ -0,0 +1,123 @@
+# Django #
+*.log
+#*.pot
+*.pyc
+__pycache__
+db.sqlite3
+media
+
+# Backup files # 
+*.bak 
+
+# If you are using PyCharm # 
+.idea/**/workspace.xml 
+.idea/**/tasks.xml 
+.idea/dictionaries 
+.idea/**/dataSources/ 
+.idea/**/dataSources.ids 
+.idea/**/dataSources.xml 
+.idea/**/dataSources.local.xml 
+.idea/**/sqlDataSources.xml 
+.idea/**/dynamic.xml 
+.idea/**/uiDesigner.xml 
+.idea/**/gradle.xml 
+.idea/**/libraries 
+*.iws /out/ 
+
+# Python # 
+*.py[cod] 
+*$py.class 
+
+# Distribution / packaging 
+.Python build/ 
+develop-eggs/ 
+dist/ 
+downloads/ 
+eggs/ 
+.eggs/ 
+lib/ 
+lib64/ 
+parts/ 
+sdist/ 
+var/ 
+wheels/ 
+*.egg-info/ 
+.installed.cfg 
+*.egg 
+*.manifest 
+*.spec 
+
+# Installer logs 
+pip-log.txt 
+pip-delete-this-directory.txt 
+
+# Unit test / coverage reports 
+htmlcov/ 
+.tox/ 
+.coverage 
+.coverage.* 
+.cache 
+.pytest_cache/ 
+nosetests.xml 
+coverage.xml 
+*.cover 
+.hypothesis/
+tests/coverage/
+coverage/
+
+
+# Jupyter Notebook 
+.ipynb_checkpoints 
+
+# pyenv 
+.python-version 
+
+# celery 
+celerybeat-schedule.* 
+
+# SageMath parsed files 
+*.sage.py 
+
+# Environments 
+.env 
+.venv 
+env/ 
+venv/ 
+ENV/ 
+env.bak/ 
+venv.bak/ 
+
+# mkdocs documentation 
+/site 
+
+# mypy 
+.mypy_cache/ 
+
+# Sublime Text # 
+*.tmlanguage.cache 
+*.tmPreferences.cache 
+*.stTheme.cache 
+*.sublime-workspace 
+*.sublime-project 
+
+# sftp configuration file 
+sftp-config.json 
+
+# Package control specific files Package 
+Control.last-run 
+Control.ca-list 
+Control.ca-bundle 
+Control.system-ca-bundle 
+GitHub.sublime-settings 
+
+# Visual Studio Code # 
+.vscode/* 
+!.vscode/settings.json 
+!.vscode/tasks.json 
+!.vscode/launch.json 
+!.vscode/extensions.json 
+.history
+
+# Dia autosave
+
+*.autosave

pyi18t_tools-0.6.0/LICENCE.md

@@ -0,0 +1,12 @@
+Licence CeCILL-C
+
+**[English version](LICENSE.md)**
+
+---
+
+Ce module python permet de gérer la traduction d'applications via un format de fichiers de traduction propre,
+conçu pour coexister avec les standards existants comme gettext (`.po`/`.mo`) et i18next. Ce module est développé
+sous la licence [CeCILL-C](http://www.cecill.info/licences/Licence_CeCILL-C_V1-fr.html).
+
+Cette licence n'est pas contaminante pour les autres modules si vous vous en servez. Cependant, si vous y
+apportez des modifications, vous devrez le soumettre au préalable ce qui permettra de l'améliorer.

pyi18t_tools-0.6.0/LICENSE.md

@@ -0,0 +1,12 @@
+CeCILL-C License
+
+**[Version française](LICENCE.md)**
+
+---
+
+This python module manages application translations through a dedicated translation file format, designed to
+coexist with existing standards such as gettext (`.po`/`.mo`) and i18next. This module has been developed under
+the [CeCILL-C](http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html) license.
+
+This license does not contaminate other modules if you use this one. However, if you
+make any modifications to it, you'll need to submit them beforehand, which will enable us to improve it.

pyi18t_tools-0.6.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: pyi18t-tools
+Version: 0.6.0
+Summary: Toolbox to manage localized messages with json and gettext functions.
+Project-URL: Homepage, https://github.com/biface/i18n
+Project-URL: Repository, https://github.com/biface/i18n.git
+Project-URL: Issues, https://github.com/biface/i18n/issues
+Author: biface
+License-File: LICENCE.md
+License-File: LICENSE.md
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: CeCILL-C Free Software License Agreement (CECILL-C)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: babel
+Requires-Dist: email-validator
+Requires-Dist: langcodes
+Requires-Dist: ndict-tools>=1.2.0
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Requires-Dist: toml
+Requires-Dist: validators
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Description-Content-Type: text/markdown
+
+![Python](https://img.shields.io/badge/Language-python-green.svg)
+![Codecov](https://img.shields.io/codecov/c/github/biface/i18n)
+
+--------------
+# i18n-tools
+
+**[Version française](README.fr.md)** (lecteur français et francophones)
+
+---
+
+## English reader and ROW
+
+### Description
+
+The **i18n-tools** project aims to simplify and modernize translation management in Python applications. It introduces a **new flexible translation file format**, independent of any dominant language, designed to coexist with existing standards such as **gettext** (`.po`/`.mo` files) and **i18next**.
+
+The goal is to provide a **modular**, **adaptable**, and **language-agnostic** solution, with native support for **translation variants**, **multiple plurals**, and transparent language fallback management.
+
+---
+
+### Roadmap
+
+The project follows a progression by deliverable value. Each version is independently usable.
+
+| Milestone   | Description                                                                                  | Status         |
+|-------------|----------------------------------------------------------------------------------------------|----------------|
+| **v0.1.x**  | Foundational cleanup — fix blocking bugs                                                     | ✅ Delivered    |
+| **v0.2.x**  | Loaders ↔ models bridge — `Book.load()`, `.i18t` extension, partial `Config → Repository`    | ✅ Delivered    |
+| **v0.3.x**  | Complete model hierarchy — `Corpus`, `FallbackBook`, `Encyclopaedia`, exceptions             | ✅ Delivered    |
+| **v0.4.x**  | Quality and coverage — error handling, circular imports, Sphinx/Furo init                    | ✅ Delivered    |
+| **v0.5.0**  | Architecture & layering hardening — DD-06 boundary sealed, `Config → Repository` completed   | ✅ Delivered    |
+| **v0.6.x**  | CI/CD & repository hygiene — `uv`/`tox-uv`, `basedpyright`, `.codecov.yml`                   | 🔶 In progress |
+| **v0.7.x**  | Test coverage — ≥ 80% enforced across the package                                            | 🔵 Planned     |
+| **v0.8.0**  | Orchestration — `core.py` high-level entry point, `fallback.py` language chain resolution    | 🔵 Planned     |
+| **v0.9.0**  | Formatting & CLI — `formatter.py` complete with `PluralRule`, CLI/REPL                       | 🔵 Planned     |
+| **v0.10.0** | Module architecture and main object components review                                        | 🔵 Planned     |
+| **v1.0.0**  | Freeze & verification — `.i18t` format frozen, public API frozen, full Sphinx docs published | 🔵 Planned     |
+| **v1.x**    | gettext interoperability — `.po`/`.mo` import/export via Babel                               | 🔵 Horizon     |
+| **v2.x**    | Third-party formats — i18next and others, central conversion hub                             | 🔵 Horizon     |
+| **v3.x**    | Complete CLI, stable API, Rust/JavaScript ports                                              | 🔵 Horizon     |
+
+---
+
+### Features
+
+| Feature                                     | v0.2.x | v0.9.0 | v1.0.0 | v1.x | v2.x |
+|---------------------------------------------|--------|--------|--------|------|------|
+| Native `.i18t` format (JSON/YAML)           | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Language-neutral identifiers                | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Variants and multiple plurals               | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Load a `Book` from `.i18t`                  | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Save a `Book` to `.i18t`                    | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Complete hierarchy (Corpus, Encyclopaedia)  | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Language fallback management                | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Interpolation and active plural rules       | ❌      | ✅      | ✅      | ✅    | ✅    |
+| CLI/REPL interface                          | ❌      | ✅      | ✅      | ✅    | ✅    |
+| `.po`/`.mo` import/export (Babel/gettext)   | ❌      | ❌      | ❌      | ✅    | ✅    |
+| i18next conversion                          | ❌      | ❌      | ❌      | ❌    | ✅    |
+
+---
+
+### Why This Project?
+
+- **Flexibility**: a format designed to adapt to all translation needs, without linguistic constraints — no language is dominant.
+- **Expressiveness**: native support for contextual variants (gender, register, context) and business plurals beyond CLDR rules.
+- **Extensibility**: layered architecture enabling conversion to existing standards (gettext, i18next) without modifying the models.
+- **Interoperability**: bridge with the Babel ecosystem for progressive compatibility with existing tools.
+
+---
+
+### License
+
+See the [license.md](LICENSE.md) file.
+
+---
+
+### Contact
+
+For any questions or contributions, open a [GitHub issue](https://github.com/biface/i18n/issues).

pyi18t_tools-0.6.0/README.md

@@ -0,0 +1,79 @@
+![Python](https://img.shields.io/badge/Language-python-green.svg)
+![Codecov](https://img.shields.io/codecov/c/github/biface/i18n)
+
+--------------
+# i18n-tools
+
+**[Version française](README.fr.md)** (lecteur français et francophones)
+
+---
+
+## English reader and ROW
+
+### Description
+
+The **i18n-tools** project aims to simplify and modernize translation management in Python applications. It introduces a **new flexible translation file format**, independent of any dominant language, designed to coexist with existing standards such as **gettext** (`.po`/`.mo` files) and **i18next**.
+
+The goal is to provide a **modular**, **adaptable**, and **language-agnostic** solution, with native support for **translation variants**, **multiple plurals**, and transparent language fallback management.
+
+---
+
+### Roadmap
+
+The project follows a progression by deliverable value. Each version is independently usable.
+
+| Milestone   | Description                                                                                  | Status         |
+|-------------|----------------------------------------------------------------------------------------------|----------------|
+| **v0.1.x**  | Foundational cleanup — fix blocking bugs                                                     | ✅ Delivered    |
+| **v0.2.x**  | Loaders ↔ models bridge — `Book.load()`, `.i18t` extension, partial `Config → Repository`    | ✅ Delivered    |
+| **v0.3.x**  | Complete model hierarchy — `Corpus`, `FallbackBook`, `Encyclopaedia`, exceptions             | ✅ Delivered    |
+| **v0.4.x**  | Quality and coverage — error handling, circular imports, Sphinx/Furo init                    | ✅ Delivered    |
+| **v0.5.0**  | Architecture & layering hardening — DD-06 boundary sealed, `Config → Repository` completed   | ✅ Delivered    |
+| **v0.6.x**  | CI/CD & repository hygiene — `uv`/`tox-uv`, `basedpyright`, `.codecov.yml`                   | 🔶 In progress |
+| **v0.7.x**  | Test coverage — ≥ 80% enforced across the package                                            | 🔵 Planned     |
+| **v0.8.0**  | Orchestration — `core.py` high-level entry point, `fallback.py` language chain resolution    | 🔵 Planned     |
+| **v0.9.0**  | Formatting & CLI — `formatter.py` complete with `PluralRule`, CLI/REPL                       | 🔵 Planned     |
+| **v0.10.0** | Module architecture and main object components review                                        | 🔵 Planned     |
+| **v1.0.0**  | Freeze & verification — `.i18t` format frozen, public API frozen, full Sphinx docs published | 🔵 Planned     |
+| **v1.x**    | gettext interoperability — `.po`/`.mo` import/export via Babel                               | 🔵 Horizon     |
+| **v2.x**    | Third-party formats — i18next and others, central conversion hub                             | 🔵 Horizon     |
+| **v3.x**    | Complete CLI, stable API, Rust/JavaScript ports                                              | 🔵 Horizon     |
+
+---
+
+### Features
+
+| Feature                                     | v0.2.x | v0.9.0 | v1.0.0 | v1.x | v2.x |
+|---------------------------------------------|--------|--------|--------|------|------|
+| Native `.i18t` format (JSON/YAML)           | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Language-neutral identifiers                | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Variants and multiple plurals               | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Load a `Book` from `.i18t`                  | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Save a `Book` to `.i18t`                    | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Complete hierarchy (Corpus, Encyclopaedia)  | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Language fallback management                | ✅      | ✅      | ✅      | ✅    | ✅    |
+| Interpolation and active plural rules       | ❌      | ✅      | ✅      | ✅    | ✅    |
+| CLI/REPL interface                          | ❌      | ✅      | ✅      | ✅    | ✅    |
+| `.po`/`.mo` import/export (Babel/gettext)   | ❌      | ❌      | ❌      | ✅    | ✅    |
+| i18next conversion                          | ❌      | ❌      | ❌      | ❌    | ✅    |
+
+---
+
+### Why This Project?
+
+- **Flexibility**: a format designed to adapt to all translation needs, without linguistic constraints — no language is dominant.
+- **Expressiveness**: native support for contextual variants (gender, register, context) and business plurals beyond CLDR rules.
+- **Extensibility**: layered architecture enabling conversion to existing standards (gettext, i18next) without modifying the models.
+- **Interoperability**: bridge with the Babel ecosystem for progressive compatibility with existing tools.
+
+---
+
+### License
+
+See the [license.md](LICENSE.md) file.
+
+---
+
+### Contact
+
+For any questions or contributions, open a [GitHub issue](https://github.com/biface/i18n/issues).

pyi18t_tools-0.6.0/pyproject.toml

@@ -0,0 +1,165 @@
+# =============================================================================
+# pyproject.toml — i18n-tools
+# =============================================================================
+# Build system, project metadata, runtime dependencies, optional extras,
+# and development dependency groups (PEP 735, managed by uv).
+#
+# Tool configuration (flake8, isort, pytest) is also consolidated here.
+# tox configuration lives in tox.ini (phase 1); merge planned for a later
+# cycle once the CI pipeline is stable.
+#
+# Dependency groups:
+#   uv sync --group dev    — full development toolchain (tox, quality, tests)
+#   uv sync --group docs   — Sphinx documentation build only
+# =============================================================================
+
+# -----------------------------------------------------------------------------
+# Build system
+# -----------------------------------------------------------------------------
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+# Explicit package location — required since [project].name
+# ("pyi18t-tools") no longer matches the src/ folder name
+# ("i18n_tools"). hatchling's default src-layout auto-detection derives
+# the expected folder from the project name; without this override it
+# would look for src/pyi18t_tools/ and find nothing. The importable
+# module stays `i18n_tools` regardless of the PyPI distribution name —
+# no code changes needed anywhere else.
+[tool.hatch.build.targets.wheel]
+packages = ["src/i18n_tools"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/i18n_tools",
+]
+
+# -----------------------------------------------------------------------------
+# Project metadata
+# -----------------------------------------------------------------------------
+[project]
+# Distribution name on PyPI/TestPyPI — "i18n-tools" was rejected by
+# TestPyPI ("too similar to an existing project", likely RF-i18n-tool,
+# one character away after normalization). "pyi18t-tools" ties to the
+# project's own .i18t format (DD-10) rather than a personal name, and
+# adds enough edit distance from the crowded i18n-tool(s)/i18tool
+# namespace to be safe (no exact or near match found on PyPI at the
+# time of writing — final confirmation only comes from the actual
+# upload, PyPI's similarity check is not publicly documented).
+# The importable package remains `i18n_tools` (src/i18n_tools/) —
+# `pip install pyi18t-tools` + `import i18n_tools`, unchanged.
+name = "pyi18t-tools"
+version = "0.6.0"
+authors = [
+    { name = "biface" },
+]
+description = "Toolbox to manage localized messages with json and gettext functions."
+readme = "README.md"
+requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "License :: CeCILL-C Free Software License Agreement (CECILL-C)",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Topic :: Utilities",
+]
+
+# -----------------------------------------------------------------------------
+# Runtime dependencies — required by any consumer of the package
+# -----------------------------------------------------------------------------
+dependencies = [
+    "ndict-tools>=1.2.0",
+    "babel",
+    "langcodes",        # IETF tag normalisation — locale.py (DD-14)
+    "email-validator",  # email validation — config.py
+    "toml",             # .toml file loading — loaders/utils.py
+    "PyYAML",           # .yaml / .i18t file loading — loaders/utils.py
+    "requests",         # HTTP calls — api.py (validate_api_url)
+    "validators",       # URL syntax check — api.py (validate_url_format, DD-37)
+]
+
+# -----------------------------------------------------------------------------
+# Project URLs
+# -----------------------------------------------------------------------------
+[project.urls]
+Homepage   = "https://github.com/biface/i18n"
+Repository = "https://github.com/biface/i18n.git"
+Issues     = "https://github.com/biface/i18n/issues"
+
+# -----------------------------------------------------------------------------
+# Optional extras — for consumers who want to run the test suite
+# without the full development toolchain
+# -----------------------------------------------------------------------------
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "pytest-cov",
+]
+
+# -----------------------------------------------------------------------------
+# Development dependency groups (PEP 735) — managed exclusively by uv
+# Not installed when a user does `pip install pyi18t-tools`
+#
+# Usage:
+#   uv sync --group dev    → installs tox, quality tools, test runners
+#   uv sync --group docs   → installs Sphinx and theme
+#   uv sync --group dev --group docs  → both at once
+# -----------------------------------------------------------------------------
+[dependency-groups]
+dev = [
+    # tox orchestration
+    "tox>=4.0",
+    "tox-uv",
+    # test runners
+    "pytest",
+    "pytest-cov",
+    # quality — static analysis
+    "basedpyright",
+    # quality — linting and formatting
+    "flake8",
+    "black",
+    "isort",
+    # quality — security
+    "bandit",
+]
+docs = [
+    "Sphinx",
+    "furo",
+]
+
+# -----------------------------------------------------------------------------
+# Tool configuration
+# -----------------------------------------------------------------------------
+
+[tool.basedpyright]
+pythonVersion = "3.10"
+pythonPlatform = "Linux"
+stubPath = "stubs"
+reportMissingTypeStubs = false
+reportUnknownVariableType = false
+reportUnknownMemberType = false
+reportUnknownArgumentType = false
+reportUnknownParameterType = false
+reportAny = false
+reportImportCycles = false
+
+[tool.flake8]
+max-line-length = 88
+ignore = ["E501"]
+extend-ignore = ["E203", "W503"]
+exclude = [".tox", ".git", "__pycache__", "build", "dist"]
+
+[tool.isort]
+profile = "black"
+line_length = 88
+known_first_party = "i18n_tools"
+multi_line_output = 3
+include_trailing_comma = true
+
+[tool.pytest.ini_options]
+markers = [
+    "network: mark test as requiring real network access (deactivated on dev branches)",
+    "timeout: mark test as making slow HTTP calls (excluded from CI)",
+]

pyi18t_tools-0.6.0/src/i18n_tools/__init__.py

@@ -0,0 +1,60 @@
+"""
+i18n-tools main package
+=======================
+
+**License:**
+This file is distributed under the terms of the `CeCILL-C Free Software License Agreement
+<https://cecill.info/licences/Licence_CeCILL-C_V1-en.html>`_. By using, modifying, or
+redistributing this file, you agree to comply with the terms of this license.
+
+**Author(s):**
+This module is authored and maintained as part of the i18n-tools package.
+
+References
+----------
+- biface/i18n#48 : public API __init__.py (DD-21, DD-22, DD-23)
+"""
+
+from i18n_tools.__static__ import (
+    I18N_TOOLS_CONFIG,
+    I18N_TOOLS_LOCALE,
+    I18N_TOOLS_MODULE_NAME,
+    I18N_TOOLS_ROOT_NAME,
+    I18N_TOOLS_TRANSLATION_FILE_EXT,
+    __version__,
+)
+
+__all__ = [
+    # Models
+    "Message",
+    "Book",
+    "Corpus",
+    "FallbackBook",
+    "Encyclopaedia",
+    # Configuration
+    "Repository",
+    "Config",
+    # Constants
+    "I18N_TOOLS_CONFIG",
+    "I18N_TOOLS_LOCALE",
+    "I18N_TOOLS_MODULE_NAME",
+    "I18N_TOOLS_ROOT_NAME",
+    "I18N_TOOLS_TRANSLATION_FILE_EXT",
+    # Version
+    "__version__",
+]
+
+from i18n_tools.config import Config  # noqa: E402
+from i18n_tools.models import (  # noqa: E402
+    Book,
+    Corpus,
+    Encyclopaedia,
+    FallbackBook,
+    Message,
+)
+from i18n_tools.models.repository import Repository  # noqa: E402
+
+# Models, Repository, and Config can now be imported in any order: __version__
+# and the other shared constants live in __static__.py, which internal modules
+# import directly, without going through this file. The former import-order
+# constraint (biface/i18n#47) no longer applies.

pyi18t_tools-0.6.0/src/i18n_tools/__static__.py

@@ -0,0 +1,82 @@
+"""
+Static and global variables module
+==================================
+
+"""
+
+import os
+from pathlib import Path
+from typing import Literal
+
+__version__ = "0.6.0"
+"""
+This variable stores the package version. It lives here (rather than in
+``__init__.py``) so that internal modules can depend on it without creating
+a circular import back through the package root. Internal consumers should
+import this module (``from i18n_tools import __static__``) and read
+``__static__.__version__`` rather than copy-importing the name, so that an
+override made after import time (``i18n_tools.__static__.__version__ = ...``)
+remains visible everywhere consistently.
+"""
+
+I18N_TRANSLATION_FORMAT = {"json", "yaml"}
+"""
+This format defines the set of standard storage files for translations
+"""
+TranslationFileFormat = Literal["json", "yaml"]
+"""
+This format defines a generic type for standard storage files for translations
+"""
+I18N_TOOLS_EXT_SET = ("i18t", "itl")
+"""
+This variable stores dedicated translation file extensions for i18n-tools
+"""
+I18N_TOOLS_TRANSLATION_FILE_EXT = "i18t"
+"""
+This variable is used to store the default 4 letters translation file extension. Since the file format could be
+either JSON or YAML, translation file will be _domain.[json|yaml].i18n_
+"""
+I18N_TOOLS_LOCALE = "locales"
+"""
+This variable is used to store the name of the locale directory as the translation repository root in the project.
+"""
+I18N_TOOLS_MESSAGES = "LC_MESSAGES"
+"""
+This variable is used to store the name of the locale directory container of translation domains in the project.
+"""
+I18N_TOOLS_BACKUP = "backup"
+"""
+This variable is used to store the name of the backup directory in the project under the config directory.
+"""
+I18N_TOOLS_TEMPLATE = "templates"
+"""
+This variable is used to store the name of the template directory in the project under the config directory. This is
+mainly used with i18n translation model.
+"""
+I18N_TOOLS_CONFIG = "_i18n_tools"
+"""
+This variable is used to store the name of the config directory in the project.
+"""
+
+I18N_TOOLS_ROOT = Path(__file__).resolve().parent
+"""
+This variable is used to store the absolute path of the root directory of the i18n-tools package.
+"""
+I18N_TOOLS_MODULE_NAME = os.path.basename(I18N_TOOLS_ROOT)
+"""
+This variable is used to store the name of the i18n-tools package.
+"""
+I18N_TOOLS_ROOT_NAME = os.path.dirname(I18N_TOOLS_ROOT)
+"""
+This variable is used to store the name of the parent directory of the i18n-tools package.
+"""
+I18N_TOOLS_CONFIG_DIR = str(
+    Path(__file__).resolve().parent / I18N_TOOLS_LOCALE / I18N_TOOLS_CONFIG
+)
+"""
+This variable is used to store the absolute path of the config directory in the project.
+"""
+I18N_TOOLS_CONFIG_FILE = "i18n_tools.yaml"
+"""
+This variable is used to define the name and format of the i18n_tools configuration file.
+"""