gcore 0.3.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

{gcore-0.3.0.dist-info → gcore-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gcore
-Version: 0.3.0
+Version: 0.5.0
 Summary: The official Python library for the gcore API
 Project-URL: Homepage, https://github.com/G-Core/gcore-python
 Project-URL: Repository, https://github.com/G-Core/gcore-python
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Requires-Python: >=3.8
@@ -27,11 +28,15 @@ Requires-Dist: httpx<1,>=0.23.0
 Requires-Dist: pydantic<3,>=1.9.0
 Requires-Dist: sniffio
 Requires-Dist: typing-extensions<5,>=4.10
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp; extra == 'aiohttp'
+Requires-Dist: httpx-aiohttp>=0.1.8; extra == 'aiohttp'
 Description-Content-Type: text/markdown
 
 # Gcore Python API library
 
-[![PyPI version](https://img.shields.io/pypi/v/gcore.svg)](https://pypi.org/project/gcore/)
+<!-- prettier-ignore -->
+[![PyPI version](https://img.shields.io/pypi/v/gcore.svg?label=pypi%20(stable))](https://pypi.org/project/gcore/)
 
 The Gcore Python library provides convenient access to the Gcore REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
@@ -99,6 +104,40 @@ asyncio.run(main())
 
 Functionality between the synchronous and asynchronous clients is otherwise identical.
 
+### With aiohttp
+
+By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
+
+You can enable this by installing `aiohttp`:
+
+```sh
+# install from PyPI
+pip install gcore[aiohttp]
+```
+
+Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
+
+```python
+import os
+import asyncio
+from gcore import DefaultAioHttpClient
+from gcore import AsyncGcore
+
+
+async def main() -> None:
+    async with AsyncGcore(
+        api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
+        http_client=DefaultAioHttpClient(),
+    ) as client:
+        project = await client.cloud.projects.create(
+            name="New Project",
+        )
+        print(project.id)
+
+
+asyncio.run(main())
+```
+
 ## Using types
 
 Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
@@ -282,15 +321,15 @@ client.with_options(max_retries=5).cloud.projects.create(
 
 ### Timeouts
 
-By default requests time out after 1 minute. You can configure this with a `timeout` option,
-which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
+By default requests time out after 2 minutes. You can configure this with a `timeout` option,
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
 from gcore import Gcore
 
 # Configure the default for all requests:
 client = Gcore(
-    # 20 seconds (default is 1 minute)
+    # 20 seconds (default is 2 minutes)
     timeout=20.0,
 )