An async Python interface to the Akismet API.
Project description
akismet-async
An asyncronous Python 3 Akismet client library.
Installation
pip install akismet-async
API key verification
Get your Akismet API key here.
from akismet import Akismet, Comment
akismet_client = Akismet(api_key="YOUR_AKISMET_API_KEY" blog="http://your.blog/",
user_agent="My App/1.0.0")
await akismet_client.verify_key()
Example usage
You can check a comment's spam score by creating a dictionary or a Comment()
object
for greater type safety:
from akismet import Akismet, Comment
akismet_client = Akismet(api_key="YOUR_AKISMET_API_KEY" blog="http://your.blog/",
user_agent="My App/1.0.0")
comment = Comment(
comment_content="This is the body of the comment",
user_ip="127.0.0.1",
user_agent="some-user-agent",
referrer="unknown"
)
first_spam_status = await akismet_client.check(comment)
second_spam_status = await akismet_client.check(
{
"user_ip": "127.0.0.2",
"user_agent": "another-user-agent",
"referrer": "unknown",
"comment_content": "This is the body of another comment",
"comment_author": 'John Doe',
"is_test": True,
}
)
check()
returns one of the following strings:
ham
probable_spam
definite_spam
unknown
Submit Ham
If you have determined that a reported comment is not spam, you can report the false positive to Akismet:
await akismet_client.submit_ham(comment)
Submit Spam
If a spam comment passes the Akismet check, report it to Akismet:
await akismet_client.submit_spam(comment)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
akismet-async-0.0.1.tar.gz
(3.7 kB
view hashes)
Built Distribution
Close
Hashes for akismet_async-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6aabe9c51d7f8716939725dd63d4405c5c17f28ba37aff3673e15fd18f49370a |
|
MD5 | c83014a7fd84745bbf0d93b4ebe967e0 |
|
BLAKE2b-256 | e3c588d17b351c4d887a0343853d793b26d8ce636375355e866ae218a27a515c |