diff --git a/Makefile b/Makefile index e0ba307..67dff50 100644 --- a/Makefile +++ b/Makefile @@ -1,9 +1,12 @@ - install: - python3 setup.py install + @python3 setup.py install --user build: - python3 setup.py sdist + @python3 setup.py sdist upload: - twine upload dist/* \ No newline at end of file + @twine upload dist/* + +clean: + @rm -rf dist/ && rm -rf *.egg-info + @echo cleaned all local builds diff --git a/README.md b/README.md index 1e6fd55..b907a57 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ # Welcome to the unofficial intellivoid-spam-protection 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/pokurt/intellivoid-spam-protection/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/OpenRestfulAPI/intellivoid-spam-protection/wiki) ## Getting Started - Installing the library: - `pip install git+https://github.com/pokurt/intellivoid-spam-protection` + `pip install git+https://github.com/OpenRestfulAPI/intellivoid-spam-protection` - For those who wants to try out Development Builds: - `pip install git+https://github.com/pokurt/intellivoid-spam-protection@dev` + `pip install git+https://github.com/OpenRestfulAPI/intellivoid-spam-protection@dev` ## Usage @@ -35,4 +35,4 @@ if __name__ == "__main__": ## Examples -All Examples are in [Examples Directory](https://github.com/pokurt/intellivoid-spam-protection/tree/master/examples) \ No newline at end of file +All Examples are in [Examples Directory](https://github.com/OpenRestfulAPI/intellivoid-spam-protection/tree/master/examples) \ No newline at end of file diff --git a/docs.md b/docs.md new file mode 100644 index 0000000..3a0c067 --- /dev/null +++ b/docs.md @@ -0,0 +1,69 @@ +# 🎉 Welcome to the unofficial intellivoid-spam-protection 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 + +## ✨ Getting Started +- Installing the library: + + `pip install git+https://github.com/OpenRestfulAPI/intellivoid-spam-protection` + +- For those who wants to try out Development Builds: + + `pip install git+https://github.com/OpenRestfulAPI/intellivoid-spam-protection@dev` + +## Methods +Currently there are 2 methods that can be called from `SPBClient()` + + +- `check_blacklist()` + - `user_id`: a `username` or `user_id` + + `Returns`: [spamprotection.types.Blacklist](https://github.com/OpenRestfulAPI/intellivoid-spam-protection/blob/fa299feab04ab1a9e11480b6af25279ef395f020/spamprotection/types.py#L13) + + _example_: + ``` + from spamprotection.sync import SPBClient() + + client = SPBClient() + status = client.check_blacklist("DeprecatedUser") + print(status) + + # OUTPUT: + ``` + +- `raw_output()` + - `user_id`: a `username` or `user_id` + + `Returns`: `[dict()]` + + _example__: + ``` + from spamprotection.sync import SPBClient() + + client = SPBClient() + status = client.raw_output("DeprecatedUser") + print(status) + + # OUTPUT: {'success': True, 'response_code': 200, 'results': {'private_telegram_id': 'TEL-9e44b25d996fefdad8bd458599a5d7aa10e47b6108d873e74ac7701a8ae546b0-24ecd995', 'entity_type': 'user', 'attributes': {'is_blacklisted': False, 'blacklist_flag': None, 'blacklist_reason': None, 'original_private_id': None, 'is_potential_spammer': False, 'is_operator': False, 'is_agent': False, 'is_whitelisted': False, 'intellivoid_accounts_verified': False, 'is_official': False}, 'language_prediction': {'language': 'en', 'probability': 0.38992445568412987}, 'spam_prediction': {'ham_prediction': 0.9904256536, 'spam_prediction': 0.009672318329241}, 'last_updated': 1609568588}} + ``` + +## Detailed Examples + +All Detailed Examples are listed inside [Examples Directory](https://github.com/OpenRestfulAPI/intellivoid-spam-protection/tree/master/examples) + + +## Development + +For those who wants to contribute or Develop the wrapper follow the instructions below: + +### Requirements + +- Installation of `python3.6` or `python3.8` +- Installation of `make`: `sudo apt install make` +- clone the github repository and switch to dev branch: `git clone https://github.com/OpenRestfulAPI/intellivoid-spam-protection && cd intellivoid-spam-protection && git checkout dev` +- setup a virtualenv and install requirements: `pip install requirements_dev.txt` +- 🎉 Finally you can test the changes in examples folder :D + + +## Note +This is an Unofficial wrapper made by an individual on Telegram. The person who owns and created this library has nothing to do with Intellivoid Company. diff --git a/examples/raw_example.py b/examples/raw_example.py new file mode 100644 index 0000000..23c3cbb --- /dev/null +++ b/examples/raw_example.py @@ -0,0 +1,20 @@ +from spamprotection.sync import SPBClient +from spamprotection.types import Blacklist + +# initializing the client +client = SPBClient() + + +def main(): + # calling for status + user = input("Enter a Username or UserID: ") + status = client.raw_output(user) + # check if status got a successful response + if status["success"]: + print(status) + else: + print("Polish Cow did not Approve this!") + + +if __name__ == "__main__": + main() diff --git a/examples/sync_example.py b/examples/sync_example.py index 6ce5660..7a5ae80 100644 --- a/examples/sync_example.py +++ b/examples/sync_example.py @@ -11,7 +11,7 @@ def main(): status = client.check_blacklist(user) # check if status got a successful response if status.success: - print((text_parser(status))) + print(text_parser(status)) else: print("Polish Cow did not Approve this!") diff --git a/setup.py b/setup.py index bfd3e52..d334153 100644 --- a/setup.py +++ b/setup.py @@ -18,7 +18,7 @@ setuptools.setup( license="GNU Lesser General Public License v3 (LGPLv3)", author="Pokurt", author_email="poki@pokurt.me", - url="https://github.com/pokurt/intellivoid-spam-protection", + url="https://github.com/OpenRestfulAPI/intellivoid-spam-protection", packages=setuptools.find_packages(), classifiers=[ "Development Status :: 3 - Alpha",