Metadata-Version: 2.4
Name: crawlora-flashscore
Version: 0.1.2
Summary: Typed Flashscore client for the Crawlora hosted API
Author: Crawlora
License-Expression: MIT
Project-URL: Homepage, https://github.com/Crawlora-org/crawlora-flashscore
Project-URL: Repository, https://github.com/Crawlora-org/crawlora-flashscore
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typing-extensions>=4.7; python_version < "3.11"
Provides-Extra: async
Requires-Dist: httpx>=0.27; extra == "async"
Provides-Extra: test
Requires-Dist: mypy>=1.11; extra == "test"
Requires-Dist: pytest>=8; extra == "test"
Dynamic: license-file

# crawlora-flashscore

Python client for Crawlora's hosted Flashscore API. It calls Crawlora's
service; it does not run a browser or scrape Flashscore 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
Flashscore or its owners.

## Install

```sh
python -m pip install crawlora-flashscore
```

## Use

```python
import os

from crawlora_flashscore import FlashscoreClient

with FlashscoreClient(api_key=os.environ["CRAWLORA_API_KEY"]) as client:
    result = client.sports()
    print(result)
```

The package also exports `Client` as an alias for `FlashscoreClient`. Operation
methods are available directly in snake_case and through the `flashscore`
group. The async package client is `AsyncFlashscoreClient`; see the [online
endpoint and parameter reference](https://github.com/Crawlora-org/crawlora-flashscore/blob/main/docs/usage.md) and [runnable example](https://github.com/Crawlora-org/crawlora-flashscore/blob/main/examples/python.py).

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-flashscore#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.
