Pyzor

-----------
Run black on the entire repository for linting.
Update documentation/release notes.

-----------
New features:
* This release adds support for Python 3 mainly.

Performance enhancements:
* Use a non blocking socket for the pyzor server, allowing asynchronous running and
graceful shutdown of the server.

Others:
* Read stdin for pyzor in binary mode (fixes `64 <https://github.com/SpamExperts/pyzor/issues/64>_)
* Catch an unhandled exception when running pyzor as a user with no home directory (fixes <86 https://github.com/SpamExperts/pyzor/issues/68>_)
* Miscellaneous changes related to Python 3 support (up to Python 3.12) that remove deprecated methods/syntax.

-----------

Changed whitelist URL to https://app.pyzor.org/whitelist/

-----------

New features:

* New pyzor commands ``local_[un]whitelist`` are available for managing
a local whitelist on the client side. (`10 <https://github.com/SpamExperts/pyzor/issues/10>`_)
* New ``PreFork`` option for the pyzor server. This allows creating multiple
workers for handling pyzor requests. (`26 <https://github.com/SpamExperts/pyzor/issues/26>`_)

Perfomance enhancements:

* Improve usage of the Redis engine by using Hashes instead of string for
storing digests. The migration tool can be used to update you current
database. (`29 <https://github.com/SpamExperts/pyzor/issues/29>`_)

Others:

* PyPy3 compatibility verified and introduced into the Travis-CI system. (`24 <https://github.com/SpamExperts/pyzor/issues/24>`_)
* Unification of the storage engines types. (`30 <https://github.com/SpamExperts/pyzor/issues/30>`_)
* Improved check on the public whitelisting request service to skip sending
requests to whitelist message that have not been reported to the public
database or have been already whitelisted. (`27 <https://github.com/SpamExperts/pyzor/issues/27>`_)

------------

Bug fixes:

* Fix gdbm decoding issue. (`20 <https://github.com/SpamExperts/pyzor/issues/20>`_)
* Fix inconsistencies accounts and addresses. (`22 <https://github.com/SpamExperts/pyzor/issues/22>`_)

New features:

* Strip content inside ``<style>`` and `<script>` tags during HTML
normalization. (`19 <https://github.com/SpamExperts/pyzor/issues/19>`_)
* Improvements in Pyzor client error codes. (`17 <https://github.com/SpamExperts/pyzor/issues/17>`_)
* Add support for logging to Sentry (`7 <https://github.com/SpamExperts/pyzor/issues/7>`_)

Perfomance enhancements:

* Do report and whitelist in a single step for MySQL Server Engine.
(`5 <https://github.com/SpamExperts/pyzor/issues/5>`_)


Others:

* You can now requests whitelisting a message by using a simple form
available at: `http://public.pyzor.org/whitelist/ <http://public.pyzor.org/whitelist/>`_

--------------

Bug fixes:

* Fix unicode decoding issues. (`1 <https://github.com/SpamExperts/pyzor/issues/1>`_)

New features:

* A new option for the pyzor server to set-up digest forwarding.
* A new script ``pyzor-migrate`` is now available. The script allows
migrating your digest database from one engine to another.
(`2 <https://github.com/SpamExperts/pyzor/issues/2>`_)

Perfomance enhancements:

* Use multiple threads when connecting to multiple servers in the pyzor
client script. (`5 <https://github.com/SpamExperts/pyzor/issues/5>`_)
* A new ``BatchClient`` is available in pyzor client API. The client
now send reports in batches to the pyzor server.
(`13 <https://github.com/SpamExperts/pyzor/issues/13>`_)

Others:

* Small adjustments to the pyzor scripts to add Windows compatibility.
* Automatically build documentation.
* Continuous integration on `Travis-CI <https://travis-ci.org/SpamExperts/pyzor>`_.
* Test coverage on `coveralls <https://coveralls.io/r/SpamExperts/pyzor?branch=master>`_.