akissa / spamc

Python spamassassin spamc client library
GNU Affero General Public License v3.0
6 stars 10 forks source link

spamc

Python spamassassin spamc client library

spamc is a python module that provides fully compliant client side functionality of the spamassassin spamd protocol

It can be used with gevent and eventlet, is thread safe and supports streaming.

Build Status Code Climate codecov.io Documentation Status License

Installation

Install from PyPi

pip install spamc

Install from Githib

git clone https://github.com/akissa/spamc.git
cd spamc
python setup.py install

Usage

Examples are in the examples directory

$ ./examples/example1.py -h
Usage: example1.py [options]

Options:
  -h, --help            show this help message and exit
  -s SERVER, --server=SERVER
                        The spamassassin spamd server to connect to
  -p PORT, --port=PORT  The spamassassin spamd server port to connect to
  -u SOCKET_PATH, --unix-socket=SOCKET_PATH
                        The spamassassin spamd unix socket to connect to
  -t, --tls             Use TLS
  -z, --use-zlib-compression
                        Use Zlib compression
  -l COMPRESS_LEVEL, --zlib-compression-level=COMPRESS_LEVEL
                        Zlib compression level
  -a USER, --user=USER  Username of the user on whose behalfthis scan is being
                        performed

Module documentation is available on readthedocs.org

Contributing

  1. Fork it (https://github.com/akissa/spamc/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

All code is licensed under the AGPLv3+ License.