quickspirit 1.0.5__tar.gz → 2.0.1__tar.gz

{quickspirit-1.0.5 → quickspirit-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: quickspirit
-Version: 1.0.5
+Version: 2.0.1
 Summary: Fast, Async Network & File Downloader Client In Python
 Home-page: https://github.com/DroidZed/QuickSpirit-Async
 License: GPL-3.0-or-later
@@ -19,9 +19,7 @@ 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
@@ -52,6 +50,37 @@ poetry add quickspirit
 uv add quickspirit
 ```
 
+## Usage:
+
+The library's getter function 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` directory.
+
 ## Testing:
 
 Clone with git:

quickspirit-2.0.1/README.md

@@ -0,0 +1,79 @@
+# 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 getter function 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` directory.
+
+## 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 .
+```
+

{quickspirit-1.0.5 → quickspirit-2.0.1}/pyproject.toml

@@ -1,8 +1,5 @@
 [tool.poetry]
-packages = [
-  { include = "quick_spirit_http" },
-  { include = "quick_spirit_downloader" },
-]
+packages = [{ include = "quickspirit" }]
 package-mode = true
 classifiers = [
   "Intended Audience :: Developers",
@@ -14,7 +11,7 @@ classifiers = [
 [project]
 name = "quickspirit"
 description = "Fast, Async Network & File Downloader Client In Python"
-version = "1.0.5"
+version = "2.0.1"
 dynamic = [ "classifiers" ]
 license = { text = "GPL-3.0-or-later" }
 readme = "README.md"
@@ -30,9 +27,6 @@ dependencies = [
 repository = "https://github.com/DroidZed/QuickSpirit-Async"
 homepage = "https://github.com/DroidZed/QuickSpirit-Async"
 
-[project.optional-dependencies]
-downloader = ["aiofiles"]
-
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3.8.0"
 ruff = "^0.5.5"

{quickspirit-1.0.5/quick_spirit_http/http → quickspirit-2.0.1/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/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 .
-```
-

quickspirit-1.0.5/quick_spirit_downloader/downloader/__init__.py

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

quickspirit-1.0.5/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

quickspirit-1.0.5/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)