| Name | spf-validator JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | Validates Sender Policy Framework (SPF) strings to ensure they are formatted correctly. |
| upload_time | 2024-11-03 18:21:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License |
| keywords |
spf
sender policy framework
email
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# spf-validator
spf-validator is a Python package for validating Sender Policy Framework strings and records to ensure they are formatted correctly.
The validation returns a list of strings where each string, if any, is an issue with the SPF record.
## Installation
Use pip to install:
```python
pip install spf-validator
```
## Usage
There are two main functions in the package: `validate_spf_string` and `validate_domain_spf`. Both of these will return a list of strings where each string, if any, is an issue with the SPF record.
To validate an SPF string, use `validate_spf_string` by passing it the string.
To use:
```python
from spf_validator import validator
issues_list = validator.validate_spf_string('v=spf1 a mx include:_spf.google.com ~all')
```
To validate an SPF record on a given domain, use `validate_domain_spf` by passing it the domain. This will retrieve the TXT records for the domain, locate the SPF record, and validate it.
To use:
```python
from spf_validator import validator
issues_list = validator.validate_domain_spf('google.com')
```
## Contributing
Community made feature requests, patches, bug reports, and contributions are always welcome.
Please review [our contributing guidelines](https://github.com/fpcorso/spf-validator/blob/main/CONTRIBUTING.md) if you decide to make a contribution.
## License
This project is licensed under the MIT License. See [LICENSE](https://github.com/fpcorso/spf-validator/blob/main/LICENSE) for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "spf-validator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "spf, sender policy framework, email",
"author": null,
"author_email": "Frank Corso <frank@frankcorso.me>",
"download_url": "https://files.pythonhosted.org/packages/2a/21/8ed37009003730d1ae6a322ebcd1421d8c38c3b8bc8813f496cc46a9e812/spf_validator-1.3.0.tar.gz",
"platform": null,
"description": "# spf-validator\r\n\r\nspf-validator is a Python package for validating Sender Policy Framework strings and records to ensure they are formatted correctly.\r\n\r\nThe validation returns a list of strings where each string, if any, is an issue with the SPF record.\r\n\r\n## Installation\r\n\r\nUse pip to install:\r\n\r\n```python\r\npip install spf-validator\r\n```\r\n\r\n## Usage\r\n\r\nThere are two main functions in the package: `validate_spf_string` and `validate_domain_spf`. Both of these will return a list of strings where each string, if any, is an issue with the SPF record.\r\n\r\nTo validate an SPF string, use `validate_spf_string` by passing it the string.\r\n\r\nTo use:\r\n\r\n```python\r\nfrom spf_validator import validator\r\n\r\nissues_list = validator.validate_spf_string('v=spf1 a mx include:_spf.google.com ~all')\r\n```\r\n\r\nTo validate an SPF record on a given domain, use `validate_domain_spf` by passing it the domain. This will retrieve the TXT records for the domain, locate the SPF record, and validate it.\r\n\r\nTo use:\r\n\r\n```python\r\nfrom spf_validator import validator\r\n\r\nissues_list = validator.validate_domain_spf('google.com')\r\n```\r\n\r\n## Contributing\r\n\r\nCommunity made feature requests, patches, bug reports, and contributions are always welcome.\r\n\r\nPlease review [our contributing guidelines](https://github.com/fpcorso/spf-validator/blob/main/CONTRIBUTING.md) if you decide to make a contribution.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License. See [LICENSE](https://github.com/fpcorso/spf-validator/blob/main/LICENSE) for more details.\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Validates Sender Policy Framework (SPF) strings to ensure they are formatted correctly.",
"version": "1.3.0",
"project_urls": {
"Repository": "https://github.com/fpcorso/spf-validator"
},
"split_keywords": [
"spf",
" sender policy framework",
" email"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "91e762f259fd57a8192504399477fd03fe539bcfe8b8ee3501cd2f28d2ecb5c6",
"md5": "d6c603ae41e2bc1dfc7f85bea95fa2c7",
"sha256": "50985e32958c86486ebc8be4b50fffef40ec49cec02cc67158d8deaff2f4b1d6"
},
"downloads": -1,
"filename": "spf_validator-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6c603ae41e2bc1dfc7f85bea95fa2c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4973,
"upload_time": "2024-11-03T18:20:58",
"upload_time_iso_8601": "2024-11-03T18:20:58.132145Z",
"url": "https://files.pythonhosted.org/packages/91/e7/62f259fd57a8192504399477fd03fe539bcfe8b8ee3501cd2f28d2ecb5c6/spf_validator-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2a218ed37009003730d1ae6a322ebcd1421d8c38c3b8bc8813f496cc46a9e812",
"md5": "1f10450de8474c2c44992f8f2d7f7051",
"sha256": "ccd2163a4267232c3e5377d067efc0f949dc0e8039589a312e9f9287abd78368"
},
"downloads": -1,
"filename": "spf_validator-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "1f10450de8474c2c44992f8f2d7f7051",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5339,
"upload_time": "2024-11-03T18:21:00",
"upload_time_iso_8601": "2024-11-03T18:21:00.575656Z",
"url": "https://files.pythonhosted.org/packages/2a/21/8ed37009003730d1ae6a322ebcd1421d8c38c3b8bc8813f496cc46a9e812/spf_validator-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-03 18:21:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fpcorso",
"github_project": "spf-validator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "spf-validator"
}
