Jilk.pw Python Wrapper is a small python module for connecting to Jilk.pw's Public API. This can help if you would like to embed items from your Discord Server into anything that binds with Python.
Project description
Jilk.pw Python Wrapper
Overview
About
jilkpw_py
is a small python module for connecting to Jilk.pw's Public API. This can help if you would like to embed items from your Discord Server into anything that binds with Python.
What is Jilk.pw
Jilk.pw is a Discord Server list to help you discover top Discord Servers; with the awesome public Discord Server List!
Documentation
Installing
To install jilkpw_py
, please simply input the following command into your terminal:
pip3 install jilkpw_py
Please note that on some systems, python3 may be bound to only pip
& not pip3
.
Using
To use jilkpw_py
, please open your preffered IDE/text editor and input the following:
Get a specific listing
from jilkpw_py import JilkpwWrapper # Import the class
wrapper_name_here = JilkpwWrapper() # Initating an object under `jilkpw_py`
dict_output = wrapper_name_here.find(478363034990149634) # Returns a dict for the given guild_id or throws an exeption
print(dict_output) # Print the output to screen
Get all listings
from jilkpw_py import JilkpwWrapper # Import the class
wrapper_name_here = JilkpwWrapper() # Initating an object under `jilkpw_py`
dict_output = wrapper_name_here.all() # Returns a dict of all servers on jilkpw or throws an exeption
print(dict_output) # Print the output to screen
Note
This will give a basic implamentation of jilkpw_py
but as you can see below, there are various errors you have to catch (hint: try/except around the dict_output = wrapper_name_here.find(478363034990149634)
line).
Exceptions
HTTP Errors
NotFound
: Jilk.pw could not find the guild_id you passed inBadRequest
: A request to Jilk.pw was not handled properly & was abortedNotAuthed
: For whatever reason, you are not authorized to use Jilk.pw's public apiWebMoved
: Jilk.pw has movedWebTimeout
: Request to Jilk.pw timed out, please try again laterUriTooLong
: The URI is too long for the server to processMiscError
: HTTP response code isx
(not incl 200 or previously used)
Misc Errors
CannotMain
: If you try to run the module directly
scOwez, 2019. Licensed under Apache
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file jilkpw_py-1.0.4.tar.gz
.
File metadata
- Download URL: jilkpw_py-1.0.4.tar.gz
- Upload date:
- Size: 3.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24ce043133fa4ce5eb3d8a08704ccce98fd4d90ca18915e11c9dd86d3a8a917f |
|
MD5 | 7479461ade2333343b51c130608fe562 |
|
BLAKE2b-256 | cc52b09a3fd439b59a098f9318e02b85ba732755fdc5cbd6f1abbf00162f5744 |