Metadata-Version: 2.3
Name: howler-client
Version: 2.4.0
Summary: The Howler client library facilitates issuing requests to Howler
License: MIT
Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs
Author: Canadian Centre for Cyber Security
Author-email: howler@cyber.gc.ca
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries
Requires-Dist: coverage[toml] (>=7.6.1,<8.0.0)
Requires-Dist: diff-cover (>=9.2.0,<10.0.0)
Requires-Dist: pycryptodome (>=3.20.0,<4.0.0)
Requires-Dist: python-baseconv (>=1.2.2,<2.0.0)
Requires-Dist: requests[security] (>=2.32.0,<3.0.0)
Project-URL: Documentation, https://cybercentrecanada.github.io/howler-docs/developer/client/
Project-URL: Homepage, https://cybercentrecanada.github.io/howler-docs/
Project-URL: Repository, https://github.com/CybercentreCanada/howler-client
Description-Content-Type: text/markdown

# Howler Client Library

The Howler client library facilitates issuing requests to Howler.

## Requirements

1. Python 3.9 and up

## Running the Tests

### Prepare the API

```bash
sudo mkdir -p /etc/howler/conf
sudo mkdir -p /var/cache/howler
sudo mkdir -p /var/lib/howler
sudo mkdir -p /var/log/howler

sudo chown -R $USER /etc/howler
sudo chown $USER /var/cache/howler
sudo chown $USER /var/lib/howler
sudo chown $USER /var/log/howler

cd api/dev
docker compose up -d --build

cd ..
poetry install --with dev,test,types
cp test/unit/config.yml /etc/howler/conf/config.yml
cp build_scripts/classification.yml /etc/howler/conf/classification.yml
poetry run server

poetry run python howler/odm/random_data.py
```

### Run the Tests

```bash
cd client

poetry run test
```

