lowrapper
The lowrapper is a library for quickly and easily creating an environment for tapping the API without implementation.
Typing the Client class creates a simple API wrapper with type completion.
Also, it may also be useful for creating API wrappers.
Let's start by looking at Simple Example below to see how it works.
Simple Example
This is the weather forecast API's low wrapper.
# 天気予報 API the low level wrapper
from lowrapper import Client, Response
client: Client[Response] = Client("https://weather.tsukumijima.net/api/")
print(client.forecast(method="GET", params={"city": 120010}).json())
# [GET] https://weather.tsukumijima.net/api/forecast?city=120010
This example uses the weather forecast API to get weather forecast information for Chiba Prefecture.
(Chiba Prefecture is a prefecture in Japan.)
Explanation for Simple Example
- Pass the API endpoint base URL to
Client. - Write the end of the endpoint of the API in the class attribute. (
client.forecast->/forecast) - Hit the API.
As you can see, you can create an endpoint with Python class attributes.
You can also change the arguments for the request. (Let's see FAQs)
Installation
You can install lowrapper by running this command.
pip install lowrapper
If you want asynchronous lowrapper, you can get this by running this command.
pip install lowrapper[asynchronous] or pip install aiohttp
FAQs
Q: I want to hit an endpoint that changes dynamically.
A: You can hit this by using like dictionary as follows.
client[YOUR_DYNAMIC_ENDPOINT]("GET", ...)
Q: I want to type the client class.
A: You can type by inheriting the client class as follows.
from lowrapper import Client, Path, Response
class Endpoint(Path[Response]):
ping: Path[Response]
class MySomeAPIClient(Client[Response]):
some: Endpoint
client = MySomeAPIClient("https://api.some.web/")
print(client.some.ping(method="GET").text)
# [GET] https://api.some.web/some/ping
# -> Some's PONG!
Q: I want to use asynchronous version of lowrapper.
A: You can use it by importing lowrapper.aio as follows.
from lowrapper.aio import Client, Path, CoroutineResponse
client: Client[CoroutineResponse] = Client("https://asynchronous.love/")
And you should install aiohttp to request.
Q: I want to change the request args.
A: You can change the request args like bellow.
from lowrapper import Client, Path, Method, Response
class MyClient(Client[Response]):
BASE = "https://simple.chat/"
def __init__(self):
super().__init__(self.BASE)
def send(self, message: str) -> Response:
return self.__request__(self, method="POST", json={"content": message})
client = MyClient()
client.send("Hi")
# [POST] https://simple.chat/send
# {"content": "Hi"}
Q: I want a guide.
A: Let's see documentation's guide.
Contributing
Let's cooperate by making an issue and submitting a Pull Request!
In case of Pull Request, please try not to change the style of the code. (65% PEP8)
Documentation
UserGuide and Documentation is here.
27 Nov 19, 2022
2 Feb 9, 2022
20 Sep 4, 2022
24 Dec 28, 2022
1 Oct 2, 2021
3k Dec 29, 2022
904 Jan 2, 2023
7 Dec 11, 2022
11 Nov 21, 2022
5 May 14, 2022
5 Nov 30, 2022
2 Jul 28, 2022
4 Jan 24, 2022
65 Nov 22, 2022
1 Jan 17, 2022
23 Oct 26, 2021
1 Jan 08, 2022
3 Jan 24, 2022
1 Jan 17, 2022
20 Nov 23, 2022
15 Dec 26, 2022
28 Dec 25, 2022
7 Dec 03, 2022
1.7k Jan 07, 2023
74 Jan 08, 2023
43 Jun 11, 2022
6 May 28, 2022
1.4k Jan 04, 2023