v3.0.0

v3.0.0 is out 🎉

After a long time of no major releases, I am proud to announce spamfilter v3.0.0 with many major and minor improvements across the board, including new filters, deprecations and Quality-of-Life features.

New filters and changes

• the OpenAI filter has been promoted to the main mean of communication with LLMs to filter spam
• the Ollama filter is now deprecated as announced in the prior v2.0.0 release
• AI usage and safety info page added to the library's documentation
• improved error handling in the BlocklistFromJSON filter
• the Length filter now has two new modes, fill-only and shorten-only
• improved and fixed docstrings (will be updated to Google syntax in future releases)
• minor code quality improvements under the hood for better maintainability, Pylint error fixes

Full Changelog: v2.2.0...v3.0.0

v2.2.0

v2.2.0 is out 🎉

This release introduces spamfilter v2.2.0, which primarily features a new, general-purpose OpenAI API compatible filter. This filter can make requests to any OpenAI API compatible endpoint of your choice, including Ollama, which exposes one.

New filters and changes

• add OpenAI API compatible filter
• prepare deprecation of Ollama filter in favor of the new OpenAI filter that is more general-purpose in order to de-duplicate code
• minor fixes and documentation improvements

Full Changelog: v2.1.0...v2.2.0

v2.1.0

v2.1.0 is out 🎉

I'm happy to announce spamfilter version 2.1.0! Most importantly, it adds a general-purpose machine learning-based text classification filter to allow you to easily improve the accuracy of your spam filtering pipelines with any Hugging Face text classification model of your choice!

New filters and changes

• added the MLTextClassifier filter, which is a simple to use, batteries included filter to get you started with AI spam filtering quickly
• extended documentation, fixed minor mistakes
• other minor fixes; consult the change log for more information

Responsible usage of AI/ML

I've added an extra documentation page dedicated to the dangers of mindlessly using artificial intelligence like text classifiers, along with some questions asking you - yes, you - the user whether you actually need it or another, more viable option exists.

Full Changelog: v2.0.1-fix...v2.1.0

v2.0.1

v2.0.1 is out 🎉

This is a minor patch to fix a broken link on the PyPI page of the project. It does not contain any further changes in comparison to v2.0.0.

For the new features in version 2.0.0, click here.

v2.0.0

v2.0.0 is out 🎉

spamfilter version 2.0.0 marks a next step in the extensibility and scope of the library. It adds several new filters, renames some mechanics and comes with an even higher-quality code base. The entire documentation has been overhauled and is now available here.

Caution

This is a breaking change, so you will need to migrate your existing code.

New features and fixes

• renamed Machine to Pipeline
• renamed PersonalInformation to a much more reasonable Regex
• added API filter to call third-party spam filtering services
• added Ollama filter to integrate large language models into spam filtering pipelines
• massively improved documentation website
• added further CI/CD workflow stability
• migrate the Result object to a dataclass
• improved type annotations

What else changed?

• Add missing deps to workflow installations in #8

Full Changelog: v1.0.0...v2.0.0

v1.0.0

v1.0.0 is out 🎉

This is the first stable, major version of spamfilter. Anyone familiar to SemVer might notice that this is a breaking change, introducing potential incompatibilities in the API. Please carefully review the behavior of your application before using the upgraded version in your application.

New features and fixes

• massively improved code maintainability
• changed or added types to even more parts of the code
• fixed critical bug in Symbols filter that would generate gibberish when using the crop mode
• added abs_safe_min to Capitals filter
• performed reworks of the documentation
• made the testing of the module way more extensive
• added more automation to the project, see below
• ... many tiny usability changes!

What else changed?

• Add Pylint CI/CD workflow in #4
• Add Pytest and python package build to CD/CD workflows in #5
• Improve installation command formatting in #6
• Add CI/CD for PyPI automated publishing in #7

Full Changelog: https://github.com/mags0ft/spamfilter/commits/v1.0.0