https://github.com/droidzed/quickspirit-async
Fast HTTP Requests has never been fun before !
https://github.com/droidzed/quickspirit-async
aiofiles fast httpx library package python python3
Last synced: 28 days ago
JSON representation
Fast HTTP Requests has never been fun before !
- Host: GitHub
- URL: https://github.com/droidzed/quickspirit-async
- Owner: DroidZed
- License: gpl-3.0
- Created: 2024-07-29T14:44:53.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-03-04T23:43:30.000Z (3 months ago)
- Last Synced: 2025-04-19T22:44:02.658Z (about 1 month ago)
- Topics: aiofiles, fast, httpx, library, package, python, python3
- Language: Python
- Homepage: https://pypi.org/project/quickspirit/
- Size: 1.58 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quick Spirit 🐬
An easy to use HTTP client with a fast downloader.
This library was made with the famous [HTTPX](https://www.python-httpx.org/) library!
I originally intended to make a small module to refactor my networking layer in my apps using httpx, and ended up creating a library !
----
## Install
```sh
# PIP:
pip install quickspirit
# Poetry:
poetry add quickspirit
# UV:
uv add quickspirit
```
## Usage:
The library's internal mechanism returns a bytes data repersenting the bytes coming in from the network. Since we don't know the shape of the data, I delegated the responsibility to you to figure out how to parse it to your liking.
A sample code would look like this:
```py
from quickspirit import HttpAsyncClient
from asyncio import run
from json import joads
from typing import Any
async def main():
result = await HttpAsyncClient().get("https://some distant url returning json hopefully")
if result.Error:
raise result.Error
data: dict[str, Any] = loads(result.Data)
# do whatever you need now that you have the data...
if __name__ == "__main__":
run(main())
```
A complete example can be found in the [`example`](https://github.com/DroidZed/QuickSpirit-Async/tree/main/example) directory.
## Testing:
Clone with git:
```bash
git clone https://github.com/DroidZed/QuickSpirit-Async && cd QuickSpirit-Async
```
Create a virtual env and install the dependencies in it:
```sh
python3 -m venv .venv && .venv/Scripts/activate
# I built the project using poetry, so you may want to have that inside of your venv ! No need to install it in your global python install.
poetry install --no-root
```
Run the tests with pytest:
```sh
# Here I'm using uv to run the tests, but the command should be the same for other package manager:
pytest -vs .
```
## Licensing
The project is under the GPT-3.0 License, see the [`License`](https://github.com/DroidZed/QuickSpirit-Async/blob/main/LICENSE) file for details.