| Name | python-advanced-typing JSON |
| Version |
0.15
JSON |
| download |
| home_page | https://github.com/YidiSprei/PythonAdvancedTyping |
| Summary | An intuitive Python utility to ensure type accuracy in your code. With capabilities to validate single or multiple variables, it streamlines type verification, boosting code reliability and readability. |
| upload_time | 2023-10-04 06:05:43 |
| maintainer | |
| docs_url | None |
| author | Yidi Sprei |
| requires_python | |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Python Advanced Typing
## Overview
### Description
`python-advanced-typing` is a simple Python package to help developers validate the types of variables in their codebase. With support for checking individual variables or multiple variables at once, it offers a concise way to ensure that the data you're working with meets your expectations.
### Features
- **Single Variable Check**: Compare a variable's type against a specific type or multiple acceptable types.
- **Bulk Verification**: Validate the types of multiple variables simultaneously using a list.
## Setup Instructions
**Install the Package using**:
```
pip install python-advanced-typing
```
## Usage
### Check Individual Variable
```python
from python_advanced_typing import check_type
x = "Hello"
check_type(x, "x", str)
```
### Bulk Check Multiple Variables
```python
from python_advanced_typing import check_type
x = "Hello"
y = 123
z = [1, 2, 3]
check_type(
(x, "x", str),
(y, "y", int),
(z, "z", list)
)
```
## Contributing
As this is an open-source project hosted on GitHub, your contributions and improvements are welcome! Follow these general steps for contributing:
1. **Fork the Repository**:
Start by forking the main repository to your personal GitHub account.
2. **Clone the Forked Repository**:
Clone your forked repository to your local machine.
```
git clone https://github.com/YidiSprei/PythonAdvancedTyping.git
```
3. **Create a New Branch**:
Before making any changes, create a new branch:
```
git checkout -b feature-name
```
4. **Make Your Changes**:
Implement your features, enhancements, or bug fixes.
5. **Commit & Push**:
```
git add .
git commit -m "Descriptive commit message about changes"
git push origin feature-name
```
6. **Create a Pull Request (PR)**:
Go to your forked repository on GitHub and click the "New Pull Request" button. Make sure the base fork is the original repository, and the head fork is your repository and branch. Fill out the PR template with the necessary details.
Remember to always be respectful and kind in all interactions with the community. It's all about learning, growing, and helping each other succeed!
## Acknowledgments
Crafted with 💙 by Yidi Sprei. Kudos to all contributors and the expansive Python community for encouragement and motivation.
Raw data
{
"_id": null,
"home_page": "https://github.com/YidiSprei/PythonAdvancedTyping",
"name": "python-advanced-typing",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Yidi Sprei",
"author_email": "yididev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/78/f3/bc9abd0c3d9dc71e2d902fd4e52675f4924c06fc552586bdc280c9976d97/python-advanced-typing-0.15.tar.gz",
"platform": null,
"description": "\n# Python Advanced Typing\n\n## Overview\n\n### Description\n\n`python-advanced-typing` is a simple Python package to help developers validate the types of variables in their codebase. With support for checking individual variables or multiple variables at once, it offers a concise way to ensure that the data you're working with meets your expectations.\n### Features\n- **Single Variable Check**: Compare a variable's type against a specific type or multiple acceptable types.\n- **Bulk Verification**: Validate the types of multiple variables simultaneously using a list.\n## Setup Instructions\n**Install the Package using**:\n\n```\npip install python-advanced-typing\n```\n\n## Usage\n### Check Individual Variable\n```python\nfrom python_advanced_typing import check_type\n\nx = \"Hello\"\ncheck_type(x, \"x\", str)\n```\n### Bulk Check Multiple Variables\n```python\nfrom python_advanced_typing import check_type\n\nx = \"Hello\"\ny = 123\nz = [1, 2, 3]\n\ncheck_type(\n (x, \"x\", str),\n (y, \"y\", int),\n (z, \"z\", list)\n)\n```\n\n## Contributing\nAs this is an open-source project hosted on GitHub, your contributions and improvements are welcome! Follow these general steps for contributing:\n\n1. **Fork the Repository**: \nStart by forking the main repository to your personal GitHub account.\n\n2. **Clone the Forked Repository**: \nClone your forked repository to your local machine.\n\n ```\n git clone https://github.com/YidiSprei/PythonAdvancedTyping.git\n ```\n\n3. **Create a New Branch**: \nBefore making any changes, create a new branch:\n\n ```\n git checkout -b feature-name\n ```\n\n4. **Make Your Changes**: \nImplement your features, enhancements, or bug fixes.\n\n5. **Commit & Push**:\n\n ```\n git add .\n git commit -m \"Descriptive commit message about changes\"\n git push origin feature-name\n ```\n \n6. **Create a Pull Request (PR)**: \nGo to your forked repository on GitHub and click the \"New Pull Request\" button. Make sure the base fork is the original repository, and the head fork is your repository and branch. Fill out the PR template with the necessary details.\n\nRemember to always be respectful and kind in all interactions with the community. It's all about learning, growing, and helping each other succeed!\n\n## Acknowledgments\nCrafted with \ud83d\udc99 by Yidi Sprei. Kudos to all contributors and the expansive Python community for encouragement and motivation.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "An intuitive Python utility to ensure type accuracy in your code. With capabilities to validate single or multiple variables, it streamlines type verification, boosting code reliability and readability.",
"version": "0.15",
"project_urls": {
"Homepage": "https://github.com/YidiSprei/PythonAdvancedTyping"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d856bac6b901da6d8584f4d20b17dd9f9fdedfbfaf74f18c179276c95b1f616",
"md5": "9f2ef3aef5d826b47a8b07ed4043e3cc",
"sha256": "aee2fddd833a2fc2bd994c69fe173c3cbfd63b9d6824efeab7f8e9b3cd86de43"
},
"downloads": -1,
"filename": "python_advanced_typing-0.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9f2ef3aef5d826b47a8b07ed4043e3cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4430,
"upload_time": "2023-10-04T06:05:42",
"upload_time_iso_8601": "2023-10-04T06:05:42.170173Z",
"url": "https://files.pythonhosted.org/packages/0d/85/6bac6b901da6d8584f4d20b17dd9f9fdedfbfaf74f18c179276c95b1f616/python_advanced_typing-0.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "78f3bc9abd0c3d9dc71e2d902fd4e52675f4924c06fc552586bdc280c9976d97",
"md5": "58e12a6474cedb1e4c23fb8cd58a2f90",
"sha256": "aae1d5f8e50e9299008aa977a0ef1b0943af283051378e9003ba6e7e05e0f420"
},
"downloads": -1,
"filename": "python-advanced-typing-0.15.tar.gz",
"has_sig": false,
"md5_digest": "58e12a6474cedb1e4c23fb8cd58a2f90",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3903,
"upload_time": "2023-10-04T06:05:43",
"upload_time_iso_8601": "2023-10-04T06:05:43.134487Z",
"url": "https://files.pythonhosted.org/packages/78/f3/bc9abd0c3d9dc71e2d902fd4e52675f4924c06fc552586bdc280c9976d97/python-advanced-typing-0.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-04 06:05:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "YidiSprei",
"github_project": "PythonAdvancedTyping",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "python-advanced-typing"
}
