quickspirit 2.0.0__tar.gz → 2.0.2__tar.gz

{quickspirit-2.0.0 → quickspirit-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: quickspirit
-Version: 2.0.0
+Version: 2.0.2
 Summary: Fast, Async Network & File Downloader Client In Python
 Home-page: https://github.com/DroidZed/QuickSpirit-Async
 License: GPL-3.0-or-later
@@ -24,7 +24,7 @@ Requires-Dist: httpx (>=0.27.0)
 Project-URL: Repository, https://github.com/DroidZed/QuickSpirit-Async
 Description-Content-Type: text/markdown
 
-# Quick Spirit
+# Quick Spirit 🐬
 
 An easy to use HTTP client with a fast downloader.
 
@@ -50,6 +50,37 @@ poetry add quickspirit
 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:
@@ -58,13 +89,17 @@ Clone with git:
 git clone https://github.com/DroidZed/QuickSpirit-Async && cd QuickSpirit-Async
 ```
 
-Create a virtual env:
+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 (install it first using your package manager of choice):
+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:
@@ -72,4 +107,7 @@ Run the tests with pytest (install it first using your package manager of choice
 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.
 

quickspirit-2.0.2/README.md

@@ -0,0 +1,86 @@
+# 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.

{quickspirit-2.0.0 → quickspirit-2.0.2}/pyproject.toml

@@ -11,7 +11,7 @@ classifiers = [
 [project]
 name = "quickspirit"
 description = "Fast, Async Network & File Downloader Client In Python"
-version = "2.0.0"
+version = "2.0.2"
 dynamic = [ "classifiers" ]
 license = { text = "GPL-3.0-or-later" }
 readme = "README.md"

quickspirit-2.0.0/README.md

@@ -1,48 +0,0 @@
-# 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
-```
-
-## Testing:
-
-Clone with git:
-
-```bash
-git clone https://github.com/DroidZed/QuickSpirit-Async && cd QuickSpirit-Async
-```
-
-Create a virtual env:
-
-```sh
-python3 -m venv .venv && .venv/Scripts/activate
-```
-
-Run the tests with pytest (install it first using your package manager of choice):
-
-```sh
-# Here I'm using uv to run the tests, but the command should be the same for other package manager:
-
-pytest -vs .
-```
-