| Name | spf-validator JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | |
| Summary | Validates Sender Policy Framework (SPF) strings to ensure they are formatted correctly. |
| upload_time | 2023-12-07 16:19:51 |
| maintainer | |
| docs_url | None |
| author | |
| 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.
When contributing please ensure you follow the guidelines below so that we can keep on top of things.
### Creating Issues
* If you have any bugs or feature requests for the plugin itself, please [create an issue](https://github.com/fpcorso/spf-validator/issues/new)
* For bug reports, please clearly describe the bug/issue and include steps on how to reproduce it
* For feature requests, please clearly describe what you would like and how it would be used
### Pull Requests
* Ensure you stick to the [PEP 8](https://peps.python.org/pep-0008/).
* When committing, reference your issue (if present) and include a note about the fix.
## 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": "",
"name": "spf-validator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "spf,sender policy framework,email",
"author": "",
"author_email": "Frank Corso <frank@frankcorso.me>",
"download_url": "https://files.pythonhosted.org/packages/ff/8b/4dad4491fd231dd25cfc2d70837e1a648f36cca535ab646b6e7b7e5d3dd3/spf_validator-1.2.1.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\nWhen contributing please ensure you follow the guidelines below so that we can keep on top of things.\r\n\r\n### Creating Issues\r\n\r\n* If you have any bugs or feature requests for the plugin itself, please [create an issue](https://github.com/fpcorso/spf-validator/issues/new)\r\n* For bug reports, please clearly describe the bug/issue and include steps on how to reproduce it\r\n* For feature requests, please clearly describe what you would like and how it would be used\r\n\r\n### Pull Requests\r\n\r\n* Ensure you stick to the [PEP 8](https://peps.python.org/pep-0008/).\r\n* When committing, reference your issue (if present) and include a note about the fix.\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.2.1",
"project_urls": {
"Repository": "https://github.com/fpcorso/spf-validator"
},
"split_keywords": [
"spf",
"sender policy framework",
"email"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "368912c89537cb2dff454472cec5a433a05da657be0a742aaca1621981a53b0a",
"md5": "1a3fd83330f8117db6ba13b6afb80692",
"sha256": "6ca10acfc340dfc31bfe30757a96397c1df9b10537a20af6f7c48fb7f94d9d24"
},
"downloads": -1,
"filename": "spf_validator-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a3fd83330f8117db6ba13b6afb80692",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4700,
"upload_time": "2023-12-07T16:19:50",
"upload_time_iso_8601": "2023-12-07T16:19:50.352518Z",
"url": "https://files.pythonhosted.org/packages/36/89/12c89537cb2dff454472cec5a433a05da657be0a742aaca1621981a53b0a/spf_validator-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ff8b4dad4491fd231dd25cfc2d70837e1a648f36cca535ab646b6e7b7e5d3dd3",
"md5": "1095035f93c0e2b02b82f912a4047e51",
"sha256": "b2d10a9b0b6e82cfb0713f5c30a171df09729c850121deba3ae8d6e8c677d697"
},
"downloads": -1,
"filename": "spf_validator-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "1095035f93c0e2b02b82f912a4047e51",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4945,
"upload_time": "2023-12-07T16:19:51",
"upload_time_iso_8601": "2023-12-07T16:19:51.952672Z",
"url": "https://files.pythonhosted.org/packages/ff/8b/4dad4491fd231dd25cfc2d70837e1a648f36cca535ab646b6e7b7e5d3dd3/spf_validator-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-07 16:19:51",
"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"
}
