# Email Validator
This project provides a simple email validation library written in Rust, with Python bindings using PyO3. The library uses the `validator` crate to validate email addresses.
## Features
- Validate email addresses using Python.
## Requirements
- Python 3.6 or higher
- `maturin` for building and publishing the Python package
## Installation
To use the Python bindings, you need to build the package first. You can do this using `maturin`.
1. Install `maturin`:
```sh
pip install maturin
```
2. Build and install the package:
```sh
maturin develop
```
This will compile the Rust code and install the Python package in your current environment.
## Usage
Here's an example of how to use the email validation function in Python:
```python
from email_validator import validate
email = "example@example.com"
is_valid = validate(email)
print(f"Is valid: {is_valid}")
```
## Development
To contribute to this project, follow these steps:
1. Clone the repository:
```sh
git clone https://github.com/yourusername/email_validator.git
cd email_validator
```
2. Install the required dependencies:
```sh
pip install maturin
```
3. Build the project:
```sh
maturin develop
```
4. Run the tests:
```sh
cargo test
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Acknowledgements
- [PyO3](https://github.com/PyO3/pyo3) for providing the Rust bindings for Python.
- [Validator](https://github.com/Keats/validator) for the email validation functionality.
```
Feel free to customize this README to better fit your project's specifics and any additional details you might want to include.
pypi-AgEIcHlwaS5vcmcCJGRmMDUzMDQ0LTE4ODAtNDRkZS1iNWE0LTM5ZWU5ODFjNTk4ZgACKlszLCI1ZTY4MDA5ZS1lNDcxLTQ3NjMtYWJjMi01YTNmNTE2YTlmMWIiXQAABiB2FS1VbmZmLabSTOLz2d0Xh8sB5HMX0GWsB7AhFP06pA
Raw data
{
"_id": null,
"home_page": null,
"name": "rusty-email-validator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "rust, email, validation",
"author": null,
"author_email": "Iorio Markus <mbalzert@gmail.com>",
"download_url": null,
"platform": null,
"description": "# Email Validator\n\nThis project provides a simple email validation library written in Rust, with Python bindings using PyO3. The library uses the `validator` crate to validate email addresses.\n\n## Features\n\n- Validate email addresses using Python.\n\n## Requirements\n\n- Python 3.6 or higher\n- `maturin` for building and publishing the Python package\n\n## Installation\n\nTo use the Python bindings, you need to build the package first. You can do this using `maturin`.\n\n1. Install `maturin`:\n\n```sh\npip install maturin\n```\n\n2. Build and install the package:\n\n```sh\nmaturin develop\n```\n\nThis will compile the Rust code and install the Python package in your current environment.\n\n## Usage\n\nHere's an example of how to use the email validation function in Python:\n\n```python\nfrom email_validator import validate\n\nemail = \"example@example.com\"\nis_valid = validate(email)\nprint(f\"Is valid: {is_valid}\")\n```\n\n## Development\n\nTo contribute to this project, follow these steps:\n\n1. Clone the repository:\n\n```sh\ngit clone https://github.com/yourusername/email_validator.git\ncd email_validator\n```\n\n2. Install the required dependencies:\n\n```sh\npip install maturin\n```\n\n3. Build the project:\n\n```sh\nmaturin develop\n```\n\n4. Run the tests:\n\n```sh\ncargo test\n```\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Acknowledgements\n\n- [PyO3](https://github.com/PyO3/pyo3) for providing the Rust bindings for Python.\n- [Validator](https://github.com/Keats/validator) for the email validation functionality.\n\n```\n\nFeel free to customize this README to better fit your project's specifics and any additional details you might want to include.\n\npypi-AgEIcHlwaS5vcmcCJGRmMDUzMDQ0LTE4ODAtNDRkZS1iNWE0LTM5ZWU5ODFjNTk4ZgACKlszLCI1ZTY4MDA5ZS1lNDcxLTQ3NjMtYWJjMi01YTNmNTE2YTlmMWIiXQAABiB2FS1VbmZmLabSTOLz2d0Xh8sB5HMX0GWsB7AhFP06pA\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"rust",
" email",
" validation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5149ee7c4e3148caee8f77cbfad40ba4e4a3127ddea826385d6e6c8899000e23",
"md5": "bfc098394dc94028cca0687da4695160",
"sha256": "54574477577265266992d074ad1f3d14eaec6700c7981b32aa1c27321fb7b773"
},
"downloads": -1,
"filename": "rusty_email_validator-0.1.0-cp312-cp312-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "bfc098394dc94028cca0687da4695160",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.8",
"size": 29144504,
"upload_time": "2024-06-18T07:59:09",
"upload_time_iso_8601": "2024-06-18T07:59:09.207657Z",
"url": "https://files.pythonhosted.org/packages/51/49/ee7c4e3148caee8f77cbfad40ba4e4a3127ddea826385d6e6c8899000e23/rusty_email_validator-0.1.0-cp312-cp312-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-18 07:59:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "rusty-email-validator"
}
JSON