Skip to content

Commit d941acf

Browse files
committed
Merge branch 'master' into dev
2 parents 452383c + 81b5ace commit d941acf

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
python-antispam
22
============
33

4-
A Python API for antispam service cleantalk.org. Invisible protection from spam, no captches, no puzzles, no animals and no math.
4+
Prevents spam in your python web apps. Cloud features allow you to use additional anti-spam functionality. Cloud features allow you to use additional anti-spam functionality, such as: Personal IP/Email lists, blocking by country, language, stop words and etc.
5+
6+
Spam attacks log - allows to view all filtered requests in the "Log of spam attacks".
7+
The log contains a detailed information about each request for a time period. At any time, you can check the request and make sure that the filtering is correct. A Python API for antispam service cleantalk.org. Invisible protection from spam, no captches, no puzzles, no animals and no math.
58

69
## How API stops spam?
710
API uses several simple tests to stop spammers.
@@ -18,6 +21,7 @@ API sends a comment's text and several previous approved comments to the servers
1821

1922
* Python 2.6 and above
2023
* Python 3 and above
24+
* CleanTalk account https://cleantalk.org/register?product=anti-spam
2125

2226
## SPAM test for text comment sample
2327

@@ -46,3 +50,14 @@ API returns Python dictionary object, where keys:
4650
* allow (0|1) - allow to publish or not, in other words spam or ham
4751
* comment (string) - server comment for requests.
4852
* id (string MD5 HEX hash) - unique request idenifier.
53+
54+
## Installing via PyPi
55+
Run the next command in the terminal:
56+
57+
```python
58+
pip install cleantalk-python-antispam
59+
```
60+
Then you can use Cleantalk class import:
61+
```python
62+
from cleantalk_python_antispam.cleantalk import CleanTalk
63+
```

0 commit comments

Comments
 (0)