a detailed README.md
- fixed typos - a minimal detailed example on main README.md
This commit is contained in:
parent
8870717fe2
commit
6009f53fd0
13
README.md
13
README.md
|
@ -1,6 +1,6 @@
|
||||||
# Welcome to the Python-Spam-Protection-API wiki!
|
# 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 see read the following [Documentation](https://github.com/intellivoid/Python-Spam-Protection-API/blob/master/docs.md)
|
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
|
## Getting Started
|
||||||
- Installing the library:
|
- Installing the library:
|
||||||
|
@ -9,7 +9,7 @@ This library handles All Requests done to https://api.intellivoid.net/spamprotec
|
||||||
|
|
||||||
- For those who wants to try out Development Builds:
|
- For those who wants to try out Development Builds:
|
||||||
|
|
||||||
`pip install git+https://github.com/intellivoid/Python-Spam-Protection-API@dev`
|
`pip install git+https://github.com/intellivoid/Python-Spam-Protection-API`
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
@ -17,9 +17,11 @@ This library handles All Requests done to https://api.intellivoid.net/spamprotec
|
||||||
from spamprotection import SPBClient
|
from spamprotection import SPBClient
|
||||||
import asyncio
|
import asyncio
|
||||||
|
|
||||||
client = SPBClient()
|
loop = asyncio.get_event_loop() # asyncio loop
|
||||||
|
client = SPBClient() # spamprotection client
|
||||||
|
|
||||||
async def main():
|
|
||||||
|
async def main(): # the main function to run in async loop
|
||||||
user = input("Enter a Username or UserID to check Spam Prediction on SPB: ")
|
user = input("Enter a Username or UserID to check Spam Prediction on SPB: ")
|
||||||
status = await client.check_blacklist(user)
|
status = await client.check_blacklist(user)
|
||||||
if status.success:
|
if status.success:
|
||||||
|
@ -28,11 +30,10 @@ async def main():
|
||||||
print("Polish Cow did not Approve this!")
|
print("Polish Cow did not Approve this!")
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
loop = asyncio.get_event_loop()
|
|
||||||
loop.run_until_complete(main())
|
loop.run_until_complete(main())
|
||||||
loop.close()
|
loop.close()
|
||||||
```
|
```
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
All Examples are in [Examples Directory](https://github.com/intellivoid/Python-Spam-Protection-API/tree/master/examples)
|
All Detailed Examples are in [Examples Directory](https://github.com/intellivoid/Python-Spam-Protection-API/tree/master/examples)
|
||||||
|
|
Loading…
Reference in New Issue