Metadata-Version: 2.4
Name: ff-inventory-api
Version: 0.2.2
Summary: Unofficial Python client for the FF-Inventory web app.
Project-URL: Homepage, https://github.com/marci4/FF-Inventory-API
Project-URL: Repository, https://github.com/marci4/FF-Inventory-API
Project-URL: Issues, https://github.com/marci4/FF-Inventory-API/issues
Author: marci4
License: MIT
License-File: LICENSE
Keywords: api,ff-inventory,firefighter,inventory,scraper
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Requires-Dist: beautifulsoup4>=4.12
Requires-Dist: requests>=2.28
Description-Content-Type: text/markdown

# ff-inventory-api

Unofficial Python client for the FF-Inventory web app.

## Features

- Session handling and login (CSRF extraction)
- Read organizational lists, create/delete lists, add/remove items
- Parse inspection basket and upcoming inspections
- Scrape users overview

## Installation

```bash
pip install ff-inventory-api
```

## Usage

```python
from ff_inventory_api import FFInventoryAPI, OrganizationalList

api = FFInventoryAPI()
api.login("user@example.com", "password")

# Lists
lists = api.get_organisational_lists()
if lists:
    first = lists[0]
    print(first.id, first.title)

# Basket
basket = api.get_basket()
print(basket)
```

## Development

- Python >= 3.10
- Install deps:

```bash
pip install -r requirements.txt -r requirements-test.txt
```

- Run tests:

```bash
pytest -q
```

## License

MIT
