| Name | spamfilter JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | |
| Summary | Create spam mitigation models with ease using fully-customizable, object oriented components. |
| upload_time | 2023-04-26 20:48:54 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | Copyright 2023 Magnus Schlinsog <magnusschlinsog@gmail.com> and GitHub contributors. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
anti spam
spam
spam filter
spam mitigation
spam protection
spamfilter
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# spamfilter
The spamfilter module is a lightweight, fast and straightforward way to build your own spam filtering machines in order to keep applications using user-generated content clean.
It's object-oriented and makes a quick, yet concise approach to remove spam easy.
## Installation
You can install spamfilter by cloning the GitHub repository or using pip:
`pip install spamfilter`
## Usage
Define a machine using several spam filters stacked onto each other.
```from spamfilter.filters import Length, Symbols
from spamfilter import Machine
m = Machine([
Length(min_length=10, max_length=200, mode="crop"),
Symbols(mode="normal")
])
TEST_STRING = "This is a test string."
print(m.check(TEST_STRING).passed)
```
## License
This project is licensed under the MIT License as found in the `LICENSE` file.
## Contributing
Feel free to contribute to the project using the GitHub repository. Additions to the spam filters, machines and documentation are always welcome!
Raw data
{
"_id": null,
"home_page": "",
"name": "spamfilter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "anti spam,spam,spam filter,spam mitigation,spam protection,spamfilter",
"author": "",
"author_email": "Magnus Schlinsog <magnusschlinsog@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/09/e8/a0b946c348a4fca0b257846b3d56060ac34dfccf942d93fda35404579534/spamfilter-0.0.2.tar.gz",
"platform": null,
"description": "\n\n# spamfilter\nThe spamfilter module is a lightweight, fast and straightforward way to build your own spam filtering machines in order to keep applications using user-generated content clean.\n\nIt's object-oriented and makes a quick, yet concise approach to remove spam easy.\n\n## Installation\nYou can install spamfilter by cloning the GitHub repository or using pip:\n\n`pip install spamfilter`\n\n## Usage\nDefine a machine using several spam filters stacked onto each other.\n\n```from spamfilter.filters import Length, Symbols\nfrom spamfilter import Machine\n\nm = Machine([\n Length(min_length=10, max_length=200, mode=\"crop\"),\n Symbols(mode=\"normal\")\n])\n\nTEST_STRING = \"This is a test string.\"\nprint(m.check(TEST_STRING).passed)\n```\n\n## License\nThis project is licensed under the MIT License as found in the `LICENSE` file.\n\n## Contributing\nFeel free to contribute to the project using the GitHub repository. Additions to the spam filters, machines and documentation are always welcome!",
"bugtrack_url": null,
"license": "Copyright 2023 Magnus Schlinsog <magnusschlinsog@gmail.com> and GitHub contributors. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Create spam mitigation models with ease using fully-customizable, object oriented components.",
"version": "0.0.2",
"split_keywords": [
"anti spam",
"spam",
"spam filter",
"spam mitigation",
"spam protection",
"spamfilter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3e8fb970fe4fbada9e51d900da21beb84f674de2d180f11363bb512d4c159c37",
"md5": "711fc1125e20c9afe5531830fb137c40",
"sha256": "792447e6466f72e9fb1ecf847393a8c7864b31712975c3ac087c3d1c4f06efe4"
},
"downloads": -1,
"filename": "spamfilter-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "711fc1125e20c9afe5531830fb137c40",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13862,
"upload_time": "2023-04-26T20:48:51",
"upload_time_iso_8601": "2023-04-26T20:48:51.322896Z",
"url": "https://files.pythonhosted.org/packages/3e/8f/b970fe4fbada9e51d900da21beb84f674de2d180f11363bb512d4c159c37/spamfilter-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "09e8a0b946c348a4fca0b257846b3d56060ac34dfccf942d93fda35404579534",
"md5": "d010708f0556567fa8ca60e35e2011c3",
"sha256": "ed5da3ebaea8740ff1d4061ccfe7e717b768d82a268aac9b90b521b7e7892425"
},
"downloads": -1,
"filename": "spamfilter-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "d010708f0556567fa8ca60e35e2011c3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 245327,
"upload_time": "2023-04-26T20:48:54",
"upload_time_iso_8601": "2023-04-26T20:48:54.033087Z",
"url": "https://files.pythonhosted.org/packages/09/e8/a0b946c348a4fca0b257846b3d56060ac34dfccf942d93fda35404579534/spamfilter-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-26 20:48:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "spamfilter"
}
