Installation guide#
The 1.3 version of akismet
is officially tested and supported
on the following versions of Python:
Python 3.8
Python 3.9
Python 3.10
Python 3.11
Python 3.12
Configuration#
To use this library, you will need to obtain an Akismet API key and register a site for
use with the Akismet web service; you can do this at <https://akismet.com>. Once you
have a key and corresponding registered site URL to use with it, place them in the
environment variables PYTHON_AKISMET_API_KEY
and PYTHON_AKISMET_BLOG_URL
, and
they will be automatically detected and used.
You can also optionally set the environment variable PYTHON_AKISMET_TIMEOUT
to a float
or int
containing a connection-timeout threshold
to use for making requests to the Akismet web service; if not set, this will
default to 1.0
(one second).
Installing from a source checkout#
If you want to work on akismet
, you can obtain a source checkout.
The development repository for akismet
is at
<https://github.com/ubernostrum/akismet>. If you have git installed, you can obtain a copy of the repository by
typing:
git clone https://github.com/ubernostrum/akismet.git
From there, you can use git commands to check out the specific revision you want, and perform an “editable” install (allowing you to change code as you work on it) by typing:
python -m pip install -e .
py -m pip install -e .