VaniLite


NameVaniLite JSON
Version 0.0.2 PyPI version JSON
download
home_pagehttps://github.com/TelegramExtended/VaniLite
SummaryMulti-Language Support Library for Python Projects
upload_time2023-12-16 07:34:16
maintainer
docs_urlNone
authorWarnerStark
requires_python
license
keywords multi-language localization i18n python vanilite vanilite-lite
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # VaniLite - Multi-Language Support for Your Project

## Overview

VaniLite is a lightweight Python library designed to simplify the implementation of multi-language support in your projects. It provides a straightforward way to manage and retrieve localized strings, making your application accessible to users in different languages.

## Features

- **Easy Integration**: Simply import the VaniLite class into your project, and you're ready to start using multi-language support.

- **JSON and YAML Support**: VaniLite supports both JSON and YAML formats for language files, giving you flexibility in how you structure your translations.

- **Dynamic String Retrieval**: Retrieve localized strings with ease, including support for dynamic formatting with arguments.

## Getting Started

1. **Installation**:

    ```bash
    pip install VaniLite
    ```

2. **Usage**:

    ```python
    from VaniLite import VaniLite

    # Initialize VaniLite with optional parameters
    VaniLite = VaniLite(language="en_US")

    # Retrieve a localized string
    greeting = VaniLite.retrieve_string("hello", default_string="Hello, World!")

    # Use dynamic formatting
    formatted_greeting = VaniLite.retrieve_string("greet_with_name", default_string="Hello, {}!", "John")
    ```

3. **Language Files**:

    Place your language files in the `/strings/` directory. VaniLite supports both JSON and YAML files. For example, for English (en_US), you can have `en_US.json` or `en_US.yaml` with the translation key-value pairs.

4. **Changing Language Dynamically**:

    ```python
    # Change the language dynamically
    VaniLite.reload_language("fr_FR")
    ```


## License

This project is licensed under the GNU v3.0 License - see the [LICENSE](./LICENSE) file for details.

---

Happy coding with multi-language support using VaniLite!

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/TelegramExtended/VaniLite",
    "name": "VaniLite",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "multi-language,localization,i18n,python,VaniLite,VaniLite-lite",
    "author": "WarnerStark",
    "author_email": "starktechfriday@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/43/3c/50aa19851d83431721efe950f5a3c0953f4d0150a0b4aa76fa1b028224dc/VaniLite-0.0.2.tar.gz",
    "platform": null,
    "description": "# VaniLite - Multi-Language Support for Your Project\r\n\r\n## Overview\r\n\r\nVaniLite is a lightweight Python library designed to simplify the implementation of multi-language support in your projects. It provides a straightforward way to manage and retrieve localized strings, making your application accessible to users in different languages.\r\n\r\n## Features\r\n\r\n- **Easy Integration**: Simply import the VaniLite class into your project, and you're ready to start using multi-language support.\r\n\r\n- **JSON and YAML Support**: VaniLite supports both JSON and YAML formats for language files, giving you flexibility in how you structure your translations.\r\n\r\n- **Dynamic String Retrieval**: Retrieve localized strings with ease, including support for dynamic formatting with arguments.\r\n\r\n## Getting Started\r\n\r\n1. **Installation**:\r\n\r\n    ```bash\r\n    pip install VaniLite\r\n    ```\r\n\r\n2. **Usage**:\r\n\r\n    ```python\r\n    from VaniLite import VaniLite\r\n\r\n    # Initialize VaniLite with optional parameters\r\n    VaniLite = VaniLite(language=\"en_US\")\r\n\r\n    # Retrieve a localized string\r\n    greeting = VaniLite.retrieve_string(\"hello\", default_string=\"Hello, World!\")\r\n\r\n    # Use dynamic formatting\r\n    formatted_greeting = VaniLite.retrieve_string(\"greet_with_name\", default_string=\"Hello, {}!\", \"John\")\r\n    ```\r\n\r\n3. **Language Files**:\r\n\r\n    Place your language files in the `/strings/` directory. VaniLite supports both JSON and YAML files. For example, for English (en_US), you can have `en_US.json` or `en_US.yaml` with the translation key-value pairs.\r\n\r\n4. **Changing Language Dynamically**:\r\n\r\n    ```python\r\n    # Change the language dynamically\r\n    VaniLite.reload_language(\"fr_FR\")\r\n    ```\r\n\r\n\r\n## License\r\n\r\nThis project is licensed under the GNU v3.0 License - see the [LICENSE](./LICENSE) file for details.\r\n\r\n---\r\n\r\nHappy coding with multi-language support using VaniLite!\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Multi-Language Support Library for Python Projects",
    "version": "0.0.2",
    "project_urls": {
        "Homepage": "https://github.com/TelegramExtended/VaniLite"
    },
    "split_keywords": [
        "multi-language",
        "localization",
        "i18n",
        "python",
        "vanilite",
        "vanilite-lite"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0e0a32582b0bd4d1bc070fbbcae5e876ec4d227f810560c313a9279b0d7e380b",
                "md5": "0d323c7395d08d1e1f5a04ae4bd65887",
                "sha256": "5e741b41282e3c61fb2955bb96b589d7be92e73ecca760bcf56ca0bea0133d30"
            },
            "downloads": -1,
            "filename": "VaniLite-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0d323c7395d08d1e1f5a04ae4bd65887",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 16553,
            "upload_time": "2023-12-16T07:34:14",
            "upload_time_iso_8601": "2023-12-16T07:34:14.299832Z",
            "url": "https://files.pythonhosted.org/packages/0e/0a/32582b0bd4d1bc070fbbcae5e876ec4d227f810560c313a9279b0d7e380b/VaniLite-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "433c50aa19851d83431721efe950f5a3c0953f4d0150a0b4aa76fa1b028224dc",
                "md5": "622edba090a852a161417297e45a58af",
                "sha256": "1ad97ea8a61f8f3c7c80b97c13301558cb1ec1107da88262747f6ad5304401f6"
            },
            "downloads": -1,
            "filename": "VaniLite-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "622edba090a852a161417297e45a58af",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 15713,
            "upload_time": "2023-12-16T07:34:16",
            "upload_time_iso_8601": "2023-12-16T07:34:16.252590Z",
            "url": "https://files.pythonhosted.org/packages/43/3c/50aa19851d83431721efe950f5a3c0953f4d0150a0b4aa76fa1b028224dc/VaniLite-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-16 07:34:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "TelegramExtended",
    "github_project": "VaniLite",
    "github_not_found": true,
    "lcname": "vanilite"
}
        
Elapsed time: 0.46598s