| Name | data-guard JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | Python data validation library |
| upload_time | 2024-09-09 10:48:28 |
| maintainer | None |
| docs_url | None |
| author | Krunal Dodiya |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# DataGuard
[](https://data-guard.gitbook.io/docs) [](https://pypi.org/project/data-guard/)
# Introduction
**DataGuard** is a powerful and flexible Python library designed to streamline data validation processes. Whether you're building data pipelines, developing web applications, or handling complex datasets, DataGuard offers a comprehensive suite of tools to ensure your data is clean, consistent, and reliable.
#### Key Features
- **Comprehensive Rule Set**:
- Validate data with a wide range of built-in rules, including checks for required fields, conditional presence, format validation, and more.
- Examples include rules for ensuring fields are present, validating email formats, checking numeric ranges, and enforcing unique constraints.
- **Custom Validators**:
- Easily create and integrate custom validation rules tailored to your specific needs.
- Extend the library with your own validation logic to handle any specific data requirements.
- **Chainable Validation**:
- Build complex validation logic by chaining multiple rules together for more nuanced data integrity checks.
- Combine rules like `Required`, `Min`, and `Email` in a single, readable chain to enforce multiple conditions on a single field.
- **Detailed Error Reporting**:
- Generate clear, actionable error messages that help you quickly identify and resolve data issues.
- Each validation failure is accompanied by descriptive messages indicating the nature of the error and the affected data fields.
- **Ease of Use**:
- Designed with simplicity in mind, DataGuard's intuitive API allows you to validate data with minimal code.
- Quickly set up validations using a declarative syntax that integrates seamlessly into your Python projects.
- **Highly Extensible**:
- Flexible architecture that integrates seamlessly with other libraries and frameworks, making it ideal for use in a variety of projects.
- Whether you're working with Flask, Django, or standalone scripts, DataGuard adapts to your environment.
# Installation
```bash
pip install data-guard
```
```python
from data_guard.validator import Validator
# Define the data to be validated
data = {"name": "John Doe", "email": "johndoe@example.com"}
# Define the validation rules
rules = {
"name": ["required"],
"email": ["required", "email"],
}
# Create a Validator instance
validator = Validator(data,rules)
# Perform the validation
response = validator.validate()
# Check if validation failed and print the errors if any
if response.validated:
print("Validation passed!", response.data)
else:
print("Validation failed with errors:", response.errors)
```
After installing the `DataGuard` package, providing a list of available validation rules is a great way to help users quickly understand the capabilities of the library..
## Contributing
Contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request on [GitHub](https://github.com/krunaldodiya/data-guard).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## More Information
For more information, visit the [documentation](https://data-guard.gitbook.io/docs) or view the package on [PyPI](https://pypi.org/project/data-guard).
Raw data
{
"_id": null,
"home_page": null,
"name": "data-guard",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Krunal Dodiya",
"author_email": "kunal.dodiya1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6a/dc/a201ff237c8c4909273686043cddd3fb88c21970fed0c3e9dbf375fe8a47/data_guard-0.0.4.tar.gz",
"platform": null,
"description": "# DataGuard\n\n[](https://data-guard.gitbook.io/docs) [](https://pypi.org/project/data-guard/)\n\n# Introduction\n\n**DataGuard** is a powerful and flexible Python library designed to streamline data validation processes. Whether you're building data pipelines, developing web applications, or handling complex datasets, DataGuard offers a comprehensive suite of tools to ensure your data is clean, consistent, and reliable.\n\n#### Key Features\n\n- **Comprehensive Rule Set**:\n - Validate data with a wide range of built-in rules, including checks for required fields, conditional presence, format validation, and more.\n - Examples include rules for ensuring fields are present, validating email formats, checking numeric ranges, and enforcing unique constraints.\n- **Custom Validators**:\n - Easily create and integrate custom validation rules tailored to your specific needs.\n - Extend the library with your own validation logic to handle any specific data requirements.\n- **Chainable Validation**:\n - Build complex validation logic by chaining multiple rules together for more nuanced data integrity checks.\n - Combine rules like `Required`, `Min`, and `Email` in a single, readable chain to enforce multiple conditions on a single field.\n- **Detailed Error Reporting**:\n - Generate clear, actionable error messages that help you quickly identify and resolve data issues.\n - Each validation failure is accompanied by descriptive messages indicating the nature of the error and the affected data fields.\n- **Ease of Use**:\n - Designed with simplicity in mind, DataGuard's intuitive API allows you to validate data with minimal code.\n - Quickly set up validations using a declarative syntax that integrates seamlessly into your Python projects.\n- **Highly Extensible**:\n - Flexible architecture that integrates seamlessly with other libraries and frameworks, making it ideal for use in a variety of projects.\n - Whether you're working with Flask, Django, or standalone scripts, DataGuard adapts to your environment.\n\n# Installation\n\n```bash\npip install data-guard\n```\n\n```python\nfrom data_guard.validator import Validator\n\n# Define the data to be validated\ndata = {\"name\": \"John Doe\", \"email\": \"johndoe@example.com\"}\n\n# Define the validation rules\nrules = {\n \"name\": [\"required\"],\n \"email\": [\"required\", \"email\"],\n}\n\n# Create a Validator instance\nvalidator = Validator(data,rules)\n\n# Perform the validation\nresponse = validator.validate()\n\n# Check if validation failed and print the errors if any\nif response.validated:\n print(\"Validation passed!\", response.data)\nelse:\n print(\"Validation failed with errors:\", response.errors)\n```\n\nAfter installing the `DataGuard` package, providing a list of available validation rules is a great way to help users quickly understand the capabilities of the library..\n\n## Contributing\n\nContributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request on [GitHub](https://github.com/krunaldodiya/data-guard).\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## More Information\n\nFor more information, visit the [documentation](https://data-guard.gitbook.io/docs) or view the package on [PyPI](https://pypi.org/project/data-guard).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python data validation library",
"version": "0.0.4",
"project_urls": {
"documentation": "https://data-guard.gitbook.io/docs",
"homepage": "https://www.proalgotrader.com",
"repository": "https://github.com/krunaldodiya/data-guard"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e756a859b36a61f3b542f284420c95731959f94db75b4cde7d408ea724a09563",
"md5": "02c2557ede4b0b02b2a5f6e4f56e3f75",
"sha256": "05050192890db76d8271aad753f95db0f8675178f6323df12238adb86d579184"
},
"downloads": -1,
"filename": "data_guard-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "02c2557ede4b0b02b2a5f6e4f56e3f75",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 18424,
"upload_time": "2024-09-09T10:48:26",
"upload_time_iso_8601": "2024-09-09T10:48:26.996463Z",
"url": "https://files.pythonhosted.org/packages/e7/56/a859b36a61f3b542f284420c95731959f94db75b4cde7d408ea724a09563/data_guard-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6adca201ff237c8c4909273686043cddd3fb88c21970fed0c3e9dbf375fe8a47",
"md5": "9426406532c31c5dbae4916db8454d20",
"sha256": "94f2ad67b742ee77e6d3f8892c9cc0f18578da5faf08f1b80dba2e4fb3d9d4e5"
},
"downloads": -1,
"filename": "data_guard-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "9426406532c31c5dbae4916db8454d20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 11501,
"upload_time": "2024-09-09T10:48:28",
"upload_time_iso_8601": "2024-09-09T10:48:28.865292Z",
"url": "https://files.pythonhosted.org/packages/6a/dc/a201ff237c8c4909273686043cddd3fb88c21970fed0c3e9dbf375fe8a47/data_guard-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-09 10:48:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "krunaldodiya",
"github_project": "data-guard",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "data-guard"
}
