quickspirit 1.0.5__py3-none-any.whl → 2.0.2__py3-none-any.whl

{quick_spirit_http/http → quickspirit}/__init__.py

@@ -1,8 +1,10 @@
+from .http_async_downloader import HttpAsyncDownloader
 from .http_errors import RequestError
 from .http_async_client import HttpAsyncClient
 from .models import Result
 
 __all__ = [
+    "HttpAsyncDownloader",
     "RequestError",
     "HttpAsyncClient",
     "Result",

{quickspirit-1.0.5.dist-info → quickspirit-2.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: quickspirit
-Version: 1.0.5
+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
@@ -19,14 +19,12 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Provides-Extra: downloader
 Requires-Dist: aiofiles (>=24.1.0)
-Requires-Dist: aiofiles ; extra == "downloader"
 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.
 
@@ -52,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:
@@ -60,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:
@@ -74,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.dist-info/RECORD

@@ -0,0 +1,9 @@
+quickspirit/__init__.py,sha256=JYvqruAR5WC_fAEPSLwJZbFcyg8VbTP9HpwPwhqBcsM,301
+quickspirit/http_async_client.py,sha256=KFllZ4eYUgw9R_V9qajzHmwcCkui1BJEbix33fFH97w,6487
+quickspirit/http_async_downloader.py,sha256=poOvyS8YjMo_E17LiI-klYStrLgRezSq7P0Y5MoQ7Tg,1073
+quickspirit/http_errors.py,sha256=_Hsj_OAfllFjZkW5NjN9c4Qw8zsSg5M4eOnNyepOKCU,272
+quickspirit/models.py,sha256=nQGsnaerR1DIUoIdjNFSoLQUc16QMJVXnBa9qTDEKIo,188
+quickspirit-2.0.2.dist-info/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+quickspirit-2.0.2.dist-info/METADATA,sha256=gFb1h4qHcM7U7UycWDih7HWfmsIGHT3Y0JgUYcwc8Lg,3106
+quickspirit-2.0.2.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
+quickspirit-2.0.2.dist-info/RECORD,,

quick_spirit_downloader/downloader/__init__.py

@@ -1,5 +0,0 @@
-from .http_async_downloader import HttpAsyncDownloader
-
-__all__ = [
-    "HttpAsyncDownloader",
-]

quick_spirit_downloader/tests/test_http_downloader.py

@@ -1,16 +0,0 @@
-import pytest
-
-from ..downloader import HttpAsyncDownloader
-
-
-class TestHttpDownloader:
-    @pytest.mark.asyncio
-    async def test_should_download_file(self):
-        client = HttpAsyncDownloader()
-        await client.get_file_from_url(
-            "https://api.coinpaprika.com/v1/coins",
-            "./db.json",
-        )
-
-        with open("./db.json", "r") as f:
-            assert f is not None

quick_spirit_http/tests/test_network_client.py

@@ -1,65 +0,0 @@
-import pytest
-from typing import Any
-from dataclasses import dataclass
-from json import loads
-
-from ..http import HttpAsyncClient
-
-
-@dataclass
-class CharacterData:
-    id: int
-    name: str
-
-    def __init__(self, json: dict[str, Any]):
-        self.id = json["id"]
-        self.name = json["name"]
-
-
-@dataclass
-class AnimeData:
-    id: int
-    name: str
-    altName: str
-
-    def __init__(self, json: dict[str, Any]):
-        self.id = json["id"]
-        self.name = json["name"]
-        self.altName = json["altName"]
-
-
-@dataclass
-class QuoteData:
-    content: str
-    anime: AnimeData
-    character: CharacterData
-
-    def __init__(self, json: dict[str, Any]):
-        self.content = json["content"]
-        self.anime = AnimeData(json["anime"])
-        self.character = CharacterData(json["character"])
-
-
-@dataclass
-class Quote:
-    status: str
-    data: QuoteData
-
-    def __init__(self, json: dict[str, Any]):
-        self.status = json["status"]
-        self.data = QuoteData(json["data"])
-
-
-class TestNetworkClient:
-    @pytest.mark.asyncio
-    async def test_should_get_a_random_anime_quote(self):
-        client = HttpAsyncClient()
-        data = await client.get("https://animechan.io/api/v1/quotes/random")
-
-        assert data.Error is None
-
-        content: Quote = Quote(loads(data.Data))
-
-        assert content.status == "success"
-
-        print(content)

quickspirit-1.0.5.dist-info/RECORD

@@ -1,16 +0,0 @@
-quick_spirit_downloader/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-quick_spirit_downloader/downloader/__init__.py,sha256=EXPvc7M9xYTjVWav3lDDqFlhcvTYjtAZtcsgTg1JQYk,102
-quick_spirit_downloader/downloader/http_async_downloader.py,sha256=poOvyS8YjMo_E17LiI-klYStrLgRezSq7P0Y5MoQ7Tg,1073
-quick_spirit_downloader/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-quick_spirit_downloader/tests/test_http_downloader.py,sha256=Ju5nC7Y76atf2WgUyN9FUQVRgFcj33jq9Cj0uu_Y8zI,418
-quick_spirit_http/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-quick_spirit_http/http/__init__.py,sha256=LQJ2SJ1ghtldWSW6KyQW2vQkNZJu6DcqPhzbO15af4s,217
-quick_spirit_http/http/http_async_client.py,sha256=KFllZ4eYUgw9R_V9qajzHmwcCkui1BJEbix33fFH97w,6487
-quick_spirit_http/http/http_errors.py,sha256=_Hsj_OAfllFjZkW5NjN9c4Qw8zsSg5M4eOnNyepOKCU,272
-quick_spirit_http/http/models.py,sha256=nQGsnaerR1DIUoIdjNFSoLQUc16QMJVXnBa9qTDEKIo,188
-quick_spirit_http/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-quick_spirit_http/tests/test_network_client.py,sha256=od4i3PYwjCbrXbXrFy521MRnWqa_jcrzrJ_fomh4eYE,1437
-quickspirit-1.0.5.dist-info/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-quickspirit-1.0.5.dist-info/METADATA,sha256=7QUCn02mP760mfF-QLqnEhjNde2-62PyX2M2uKhKIMY,2026
-quickspirit-1.0.5.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
-quickspirit-1.0.5.dist-info/RECORD,,