### `localemembers` Module Documentation
Welcome to the documentation for the `localemembers` module. This Python module is designed to detect and format system localization information using the `locale` module. It also provides an elegant and sleek graphical interface to display this information to the user.
#### Table of Contents
1. [Installation](#installation)
2. [Usage](#usage)
3. [Features](#features)
4. [Graphical Interface](#graphical-interface)
5. [Project Structure](#project-structure)
6. [Contributing](#contributing)
7. [License](#license)
### Installation
#### Automatic Installation via PyPI
You can install the `localemembers` module using pip:
```bash
pip install localemembers
```
#### Manual Installation via GitHub
For a local installation, you can clone the GitHub repository and install the module in development mode:
1. Clone the repository:
```bash
git clone https://github.com/yourusername/localemembers.git
```
2. Navigate to the project directory:
```bash
cd localemembers
```
3. Install the module in development mode:
```bash
pip install -e .
```
### Usage
Here is an example of how to use the `localemembers` module to obtain and display system localization information:
#### Running the Main Function
The main function prints the system's locale information to the console.
```python
import localemembers
# To run the main function
localemembers.main()
```
#### Running the Graphical Interface
The graphical interface displays the system's locale information in a user-friendly window.
```python
import localemembers
# To run the graphical interface
localemembers.gui_main()
```
### Features
The `localemembers` module provides the following features:
- **Detection and formatting of localization information**:
- `locale`: System locale.
- `encoding`: Locale encoding.
- `language`: Locale language.
- `country`: Locale country.
- `language_code`: Language code.
- `country_code`: Country code.
- `language_country_code`: Formatted language code.
- `currency_symbol`: Currency symbol.
- `decimal_point`: Decimal point.
- `thousands_separator`: Thousands separator.
- `date_format`: Date format.
- `time_format`: Time format.
- `radix_char`: Radix character.
- `thousands_sep`: Thousands separator.
- `yes_expr`: Regular expression for "yes".
- `no_expr`: Regular expression for "no".
- `currency_str`: Currency string.
- `era`: Era.
- `era_d_t_fmt`: Era-based date/time format.
- `era_d_fmt`: Era-based date format.
- `era_t_fmt`: Era-based time format.
- `alt_digits`: Alternative digits.
#### Detailed Description of Features
- **System Locale**: The locale setting of the system, which includes language and country information.
- **Locale Encoding**: The character encoding used by the locale.
- **Locale Language**: The language part of the locale.
- **Locale Country**: The country part of the locale.
- **Language Code**: A short code representing the language (e.g., 'en' for English).
- **Country Code**: A short code representing the country (e.g., 'US' for the United States).
- **Formatted Language Code**: A combination of the language and country codes (e.g., 'en_US').
- **Currency Symbol**: The symbol used for currency in the locale (e.g., '$' for USD).
- **Decimal Point**: The character used as a decimal point in the locale.
- **Thousands Separator**: The character used to separate thousands in numbers.
- **Date Format**: The format used for dates in the locale.
- **Time Format**: The format used for times in the locale.
- **Radix Character**: The character used as a radix point (decimal point).
- **Regular Expressions for Yes/No**: Regular expressions used to recognize positive and negative responses.
- **Currency String**: A string representing the currency, including its position relative to the value.
- **Era Information**: Information about eras used in the locale (if applicable).
- **Era-Based Date/Time Formats**: Formats for dates and times based on eras.
- **Alternative Digits**: Symbols used to represent digits in the locale.
### Graphical Interface
The `localemembers` module includes an elegant and sleek graphical interface, created with PyQt5, to display localization information to the user. The graphical interface is maximized at startup and the components are dynamic.
#### Example of the Graphical Interface
```python
import localemembers
# To run the graphical interface
localemembers.gui_main()
```
#### Graphical Interface Features
- **Maximized Window**: The window is maximized at startup for better visibility.
- **Dynamic Components**: The components in the interface are dynamic and update based on the system's locale information.
#### Description of Files
- **`localemembers/__init__.py`**: Initializes the `localemembers` module.
- **`localemembers/locale_members.py`**: Contains the main functionality for detecting and formatting localization information.
- **`localemembers/gui.py`**: Contains the code for the graphical interface.
- **`tests/__init__.py`**: Initializes the test module.
- **`tests/test_locale_members.py`**: Contains unit tests for the `localemembers` module.
- **`.gitignore`**: Specifies files and directories to be ignored by Git.
- **`LICENSE`**: Contains the license information for the project.
- **`localemembers.tr`**: Translation file (if applicable).
- **`main.py`**: Main script to run the module.
- **`README.md`**: Contains the documentation for the project.
- **`requirements.txt`**: Lists the dependencies required for the project.
- **`setup.py`**: Contains the setup configuration for the project.
### Contributing
Contributions are welcome! Please follow these steps to contribute:
1. Fork the repository on GitHub.
2. Create a new branch for your feature or bugfix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your forked repository.
5. Open a pull request on the main repository.
Please ensure that your code adheres to the project's coding standards and passes all tests.
### License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/yourusername/localemembers",
"name": "localemembers",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/56/91/5eb3ebf4273ab7305b1f94bb564e37f9bcc0fdb6cba204dd431fd4775c19/localemembers-1.1.1.tar.gz",
"platform": null,
"description": "### `localemembers` Module Documentation\r\n\r\nWelcome to the documentation for the `localemembers` module. This Python module is designed to detect and format system localization information using the `locale` module. It also provides an elegant and sleek graphical interface to display this information to the user.\r\n\r\n#### Table of Contents\r\n\r\n1. [Installation](#installation)\r\n2. [Usage](#usage)\r\n3. [Features](#features)\r\n4. [Graphical Interface](#graphical-interface)\r\n5. [Project Structure](#project-structure)\r\n6. [Contributing](#contributing)\r\n7. [License](#license)\r\n\r\n### Installation\r\n\r\n#### Automatic Installation via PyPI\r\n\r\nYou can install the `localemembers` module using pip:\r\n\r\n```bash\r\npip install localemembers\r\n```\r\n\r\n#### Manual Installation via GitHub\r\n\r\nFor a local installation, you can clone the GitHub repository and install the module in development mode:\r\n\r\n1. Clone the repository:\r\n ```bash\r\n git clone https://github.com/yourusername/localemembers.git\r\n ```\r\n\r\n2. Navigate to the project directory:\r\n ```bash\r\n cd localemembers\r\n ```\r\n\r\n3. Install the module in development mode:\r\n ```bash\r\n pip install -e .\r\n ```\r\n\r\n### Usage\r\n\r\nHere is an example of how to use the `localemembers` module to obtain and display system localization information:\r\n\r\n#### Running the Main Function\r\n\r\nThe main function prints the system's locale information to the console.\r\n\r\n```python\r\nimport localemembers\r\n\r\n# To run the main function\r\nlocalemembers.main()\r\n```\r\n\r\n#### Running the Graphical Interface\r\n\r\nThe graphical interface displays the system's locale information in a user-friendly window.\r\n\r\n```python\r\nimport localemembers\r\n\r\n# To run the graphical interface\r\nlocalemembers.gui_main()\r\n```\r\n\r\n### Features\r\n\r\nThe `localemembers` module provides the following features:\r\n\r\n- **Detection and formatting of localization information**:\r\n - `locale`: System locale.\r\n - `encoding`: Locale encoding.\r\n - `language`: Locale language.\r\n - `country`: Locale country.\r\n - `language_code`: Language code.\r\n - `country_code`: Country code.\r\n - `language_country_code`: Formatted language code.\r\n - `currency_symbol`: Currency symbol.\r\n - `decimal_point`: Decimal point.\r\n - `thousands_separator`: Thousands separator.\r\n - `date_format`: Date format.\r\n - `time_format`: Time format.\r\n - `radix_char`: Radix character.\r\n - `thousands_sep`: Thousands separator.\r\n - `yes_expr`: Regular expression for \"yes\".\r\n - `no_expr`: Regular expression for \"no\".\r\n - `currency_str`: Currency string.\r\n - `era`: Era.\r\n - `era_d_t_fmt`: Era-based date/time format.\r\n - `era_d_fmt`: Era-based date format.\r\n - `era_t_fmt`: Era-based time format.\r\n - `alt_digits`: Alternative digits.\r\n\r\n#### Detailed Description of Features\r\n\r\n- **System Locale**: The locale setting of the system, which includes language and country information.\r\n- **Locale Encoding**: The character encoding used by the locale.\r\n- **Locale Language**: The language part of the locale.\r\n- **Locale Country**: The country part of the locale.\r\n- **Language Code**: A short code representing the language (e.g., 'en' for English).\r\n- **Country Code**: A short code representing the country (e.g., 'US' for the United States).\r\n- **Formatted Language Code**: A combination of the language and country codes (e.g., 'en_US').\r\n- **Currency Symbol**: The symbol used for currency in the locale (e.g., '$' for USD).\r\n- **Decimal Point**: The character used as a decimal point in the locale.\r\n- **Thousands Separator**: The character used to separate thousands in numbers.\r\n- **Date Format**: The format used for dates in the locale.\r\n- **Time Format**: The format used for times in the locale.\r\n- **Radix Character**: The character used as a radix point (decimal point).\r\n- **Regular Expressions for Yes/No**: Regular expressions used to recognize positive and negative responses.\r\n- **Currency String**: A string representing the currency, including its position relative to the value.\r\n- **Era Information**: Information about eras used in the locale (if applicable).\r\n- **Era-Based Date/Time Formats**: Formats for dates and times based on eras.\r\n- **Alternative Digits**: Symbols used to represent digits in the locale.\r\n\r\n### Graphical Interface\r\n\r\nThe `localemembers` module includes an elegant and sleek graphical interface, created with PyQt5, to display localization information to the user. The graphical interface is maximized at startup and the components are dynamic.\r\n\r\n#### Example of the Graphical Interface\r\n\r\n```python\r\nimport localemembers\r\n\r\n# To run the graphical interface\r\nlocalemembers.gui_main()\r\n```\r\n\r\n#### Graphical Interface Features\r\n\r\n- **Maximized Window**: The window is maximized at startup for better visibility.\r\n- **Dynamic Components**: The components in the interface are dynamic and update based on the system's locale information.\r\n\r\n#### Description of Files\r\n\r\n- **`localemembers/__init__.py`**: Initializes the `localemembers` module.\r\n- **`localemembers/locale_members.py`**: Contains the main functionality for detecting and formatting localization information.\r\n- **`localemembers/gui.py`**: Contains the code for the graphical interface.\r\n- **`tests/__init__.py`**: Initializes the test module.\r\n- **`tests/test_locale_members.py`**: Contains unit tests for the `localemembers` module.\r\n- **`.gitignore`**: Specifies files and directories to be ignored by Git.\r\n- **`LICENSE`**: Contains the license information for the project.\r\n- **`localemembers.tr`**: Translation file (if applicable).\r\n- **`main.py`**: Main script to run the module.\r\n- **`README.md`**: Contains the documentation for the project.\r\n- **`requirements.txt`**: Lists the dependencies required for the project.\r\n- **`setup.py`**: Contains the setup configuration for the project.\r\n\r\n### Contributing\r\n\r\nContributions are welcome! Please follow these steps to contribute:\r\n\r\n1. Fork the repository on GitHub.\r\n2. Create a new branch for your feature or bugfix.\r\n3. Make your changes and commit them with descriptive messages.\r\n4. Push your changes to your forked repository.\r\n5. Open a pull request on the main repository.\r\n\r\nPlease ensure that your code adheres to the project's coding standards and passes all tests.\r\n\r\n### License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python module to detect and format system localization information.",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/yourusername/localemembers"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a8fe4f9634a5c34ef7302c8a149d03050c77699e84daad732349e56964cb163e",
"md5": "d130b85bdaa72565f4a97272615020d1",
"sha256": "74c5ce4d9f9b92f8980f6c1c84465bf662d3841b4a8a7405675031cb04372089"
},
"downloads": -1,
"filename": "localemembers-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d130b85bdaa72565f4a97272615020d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7899,
"upload_time": "2024-11-23T19:44:42",
"upload_time_iso_8601": "2024-11-23T19:44:42.758422Z",
"url": "https://files.pythonhosted.org/packages/a8/fe/4f9634a5c34ef7302c8a149d03050c77699e84daad732349e56964cb163e/localemembers-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "56915eb3ebf4273ab7305b1f94bb564e37f9bcc0fdb6cba204dd431fd4775c19",
"md5": "13049b240bc56427f5f390d9573edcf1",
"sha256": "b497073b33c9ad876c94f01b0b5afe772f17bacb875583e59739f52815813663"
},
"downloads": -1,
"filename": "localemembers-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "13049b240bc56427f5f390d9573edcf1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6712,
"upload_time": "2024-11-23T19:44:44",
"upload_time_iso_8601": "2024-11-23T19:44:44.346600Z",
"url": "https://files.pythonhosted.org/packages/56/91/5eb3ebf4273ab7305b1f94bb564e37f9bcc0fdb6cba204dd431fd4775c19/localemembers-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-23 19:44:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "localemembers",
"github_not_found": true,
"lcname": "localemembers"
}
JSON
