Metadata-Version: 2.4
Name: lego-store-availability
Version: 0.2.1
Summary: Check the availability of Lego™ product in stores
Home-page: https://github.com/Lunik/lego-store-availability
Author: Lunik
Author-email: lunik@tiwabbit.fr
Project-URL: Bug Tracker, https://github.com/Lunik/lego-store-availability/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: beautifulsoup4
Requires-Dist: httpx
Requires-Dist: tenacity
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist

# LEGO™ store availability

Check the availability of Lego™ product in stores.

## Disclamer

This tools is not related in any way to LEGO™ and all of it's trademark.

This tools is not designed for malicious usage and any individual or group using it this way is responsible for is own actions.

## Install

```shell
pip3 install lego-store-availability
```

## Usage

First you need to create a `LegoAPI` object :

```python
from lego_store_availability import LegoAPI

lego = LegoAPI()
```

Then request a `Store` :

```python
from lego_store_availability import Store

store = lego.store(lang="fr-fr")
```

Finally retrieve a `Product` :

```python
from lego_store_availability import Product

product = store.product(
    product_id="10307",
)

print(product.name, product.availability)
```

## Contribute

- Clone or fork the repository.
- Install dev dependencies with `pip3 install -r dev-requirements.txt`
- Develop your feature or fix
- Lint with [pylint](https://pylint.pycqa.org/en/latest/)
- Test it with [pytest](https://pytest.org) under [tests/](./tests) directory
  - Mock HTTP requests with [responses](https://github.com/getsentry/responses)
- Push & create a Pull Request on `develop` branch
- Wait for the CI (Github Action) to exit in success state
