Metadata-Version: 2.1
Name: pyrozza
Version: 0.1.0
Summary: A Python wrapper for the UK Police API
Home-page: https://github.com/regoawt/pyrozza
License: MIT
Keywords: wrapper,uk,police,crime,api
Author: Armand Rego
Author-email: armandrego@googlemail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: requests (>=2.28.1,<3.0.0)
Description-Content-Type: text/markdown

![Build](https://github.com/regoawt/pyrozza/actions/workflows/cicd.yml/badge.svg)
# pyrozza
A Python wrapper for the UK Police API

## Usage
Instantiate the client:
```python
client = pyrozza.Client()
```

Currently, the following methods are available:
```python
client.street_level_crimes(
        lat: float = None,
        lon: float = None,
        poly: List[tuple] = None,
        date: str = None,
    )
client.street_level_outcomes(
        lat: float = None,
        lon: float = None,
        poly: List[tuple] = None,
        location_id: int = None,
        date: str = None
    )

client.crime_categories(date: str = None)
```

For the geo-related kwargs, only one of the following must be provided:
- `lat` AND `lon`
- `poly`
- `location_id`
