crawlora-sofascore 0.1.2__tar.gz → 0.2.0__tar.gz

{crawlora_sofascore-0.1.2 → crawlora_sofascore-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crawlora-sofascore
-Version: 0.1.2
+Version: 0.2.0
 Summary: Typed SofaScore client for the Crawlora hosted API
 Author: Crawlora
 License-Expression: MIT
@@ -23,9 +23,9 @@ Dynamic: license-file
 # crawlora-sofascore
 
 Python client for Crawlora's hosted SofaScore API. It calls Crawlora's
-service; it does not run a browser or scrape SofaScore locally. A Crawlora
-account and `CRAWLORA_API_KEY` are required, and API use is billed under your
-Crawlora account. Crawlora is independent from and not endorsed by
+service at [Crawlora](https://crawlora.net); it does not run a browser or scrape
+SofaScore locally. A Crawlora account and `CRAWLORA_API_KEY` are required,
+and API use is billed under your Crawlora account. Crawlora is independent from and not endorsed by
 SofaScore or its owners.
 
 ## Install
@@ -34,16 +34,32 @@ SofaScore or its owners.
 python -m pip install crawlora-sofascore
 ```
 
+## Get an API key
+
+Create an account at [crawlora.net](https://crawlora.net/signup), then open the [Crawlora console](https://crawlora.net/app) for API-key setup. Set your key in the shell before running the client:
+
+```sh
+export CRAWLORA_API_KEY="your-crawlora-api-key"
+```
+
 ## Use
 
+Save this example as `example.py`, then run `python example.py` after installing the package and setting your API key.
+
 ```python
 import os
 
 from crawlora_sofascore import SofascoreClient
 
-with SofascoreClient(api_key=os.environ["CRAWLORA_API_KEY"]) as client:
-    result = client.search(q='Liverpool')
-    print(result)
+api_key = os.environ.get("CRAWLORA_API_KEY")
+if not api_key:
+    raise RuntimeError("Set CRAWLORA_API_KEY before running this example.")
+
+with SofascoreClient(api_key=api_key) as client:
+    result_1 = client.search(q='Liverpool')
+    print(result_1)
+    result_2 = client.live_events(sport='football')
+    print(result_2)
 ```
 
 The package also exports `Client` as an alias for `SofascoreClient`. Operation
@@ -51,6 +67,27 @@ methods are available directly in snake_case and through the `sofascore`
 group. The async package client is `AsyncSofascoreClient`; see the [online
 endpoint and parameter reference](https://github.com/Crawlora-org/crawlora-sofascore/blob/main/docs/usage.md) and [runnable example](https://github.com/Crawlora-org/crawlora-sofascore/blob/main/examples/python.py).
 
+### Async usage
+
+The package also exports `AsyncClient` for asynchronous requests:
+
+```python
+import asyncio
+import os
+
+from crawlora_sofascore import AsyncClient
+
+async def main():
+    api_key = os.environ.get("CRAWLORA_API_KEY")
+    if not api_key:
+        raise RuntimeError("Set CRAWLORA_API_KEY before running this example.")
+    async with AsyncClient(api_key=api_key) as client:
+        result_1 = await client.search(q='Liverpool')
+        print(result_1)
+
+asyncio.run(main())
+```
+
 The import snippet above is for a project where this PyPI package is installed. To run the checked-in example from a source checkout, install `./python` from the repository root and run `python examples/python.py`; see the [source-checkout instructions](https://github.com/Crawlora-org/crawlora-sofascore#run-examples-from-a-source-checkout).
 
 ## Configuration

crawlora_sofascore-0.2.0/README.md

@@ -0,0 +1,75 @@
+# crawlora-sofascore
+
+Python client for Crawlora's hosted SofaScore API. It calls Crawlora's
+service at [Crawlora](https://crawlora.net); it does not run a browser or scrape
+SofaScore locally. A Crawlora account and `CRAWLORA_API_KEY` are required,
+and API use is billed under your Crawlora account. Crawlora is independent from and not endorsed by
+SofaScore or its owners.
+
+## Install
+
+```sh
+python -m pip install crawlora-sofascore
+```
+
+## Get an API key
+
+Create an account at [crawlora.net](https://crawlora.net/signup), then open the [Crawlora console](https://crawlora.net/app) for API-key setup. Set your key in the shell before running the client:
+
+```sh
+export CRAWLORA_API_KEY="your-crawlora-api-key"
+```
+
+## Use
+
+Save this example as `example.py`, then run `python example.py` after installing the package and setting your API key.
+
+```python
+import os
+
+from crawlora_sofascore import SofascoreClient
+
+api_key = os.environ.get("CRAWLORA_API_KEY")
+if not api_key:
+    raise RuntimeError("Set CRAWLORA_API_KEY before running this example.")
+
+with SofascoreClient(api_key=api_key) as client:
+    result_1 = client.search(q='Liverpool')
+    print(result_1)
+    result_2 = client.live_events(sport='football')
+    print(result_2)
+```
+
+The package also exports `Client` as an alias for `SofascoreClient`. Operation
+methods are available directly in snake_case and through the `sofascore`
+group. The async package client is `AsyncSofascoreClient`; see the [online
+endpoint and parameter reference](https://github.com/Crawlora-org/crawlora-sofascore/blob/main/docs/usage.md) and [runnable example](https://github.com/Crawlora-org/crawlora-sofascore/blob/main/examples/python.py).
+
+### Async usage
+
+The package also exports `AsyncClient` for asynchronous requests:
+
+```python
+import asyncio
+import os
+
+from crawlora_sofascore import AsyncClient
+
+async def main():
+    api_key = os.environ.get("CRAWLORA_API_KEY")
+    if not api_key:
+        raise RuntimeError("Set CRAWLORA_API_KEY before running this example.")
+    async with AsyncClient(api_key=api_key) as client:
+        result_1 = await client.search(q='Liverpool')
+        print(result_1)
+
+asyncio.run(main())
+```
+
+The import snippet above is for a project where this PyPI package is installed. To run the checked-in example from a source checkout, install `./python` from the repository root and run `python examples/python.py`; see the [source-checkout instructions](https://github.com/Crawlora-org/crawlora-sofascore#run-examples-from-a-source-checkout).
+
+## Configuration
+
+Pass your key through `api_key` or read `CRAWLORA_API_KEY` from the environment.
+Keep credentials out of source control and logs. Requests go to Crawlora's
+hosted API, and response data and availability follow its current contract.

{crawlora_sofascore-0.1.2 → crawlora_sofascore-0.2.0}/crawlora_sofascore/__init__.py

@@ -6,10 +6,10 @@ from .operations import OPERATION_COUNT, OPERATION_IDS, PLATFORM
 
 Client = SofascoreClient
 AsyncClient = AsyncSofascoreClient
-__version__ = '0.1.2'
+__version__ = '0.2.0'
 DISPLAY_NAME = 'SofaScore'
 PLATFORM = 'sofascore'
-CONTRACT_REVISION = 'sha256:8dc2e500465b7b7f98054def2f9794e0e433d8bbbcba6cfb688e0b6ed0ecbfcd'
+CONTRACT_REVISION = 'sha256:91686922e3c5ab6569dbe0abd882fbbbc86c4395a86f151582a2291fb11de036'
 
 __all__ = [
     "SofascoreClient", "AsyncSofascoreClient", "Client", "AsyncClient",