Python-Spamprotection-API/README.md

40 lines
1.2 KiB
Markdown

# Welcome to the Python-Spam-Protection-API wiki!
This library handles All Requests done to https://api.intellivoid.net/spamprotection/v1/lookup. To understand how this is meant to be used, please read the following [Documentation](https://github.com/intellivoid/Python-Spam-Protection-API/blob/master/docs.md)
## Getting Started
- Installing the library:
`pip install Intellivoid-SPB`
- For those who wants to try out Development Builds:
`pip install git+https://github.com/intellivoid/Python-Spam-Protection-API`
## Usage
```
from spamprotection import SPBClient
import asyncio
loop = asyncio.get_event_loop() # asyncio loop
client = SPBClient() # spamprotection client
async def main(): # the main function to run in async loop
user = input("Enter a Username or UserID to check Spam Prediction on SPB: ")
status = await client.check_blacklist(user)
if status.success:
print(status.private_telegram_id)
else:
print("Polish Cow did not Approve this!")
if __name__ == "__main__":
loop.run_until_complete(main())
loop.close()
```
## Examples
All Detailed Examples are in [Examples Directory](https://github.com/intellivoid/Python-Spam-Protection-API/tree/master/examples)