howler-client 2.4.0.dev37__tar.gz → 2.4.0.dev43__tar.gz

{howler_client-2.4.0.dev37 → howler_client-2.4.0.dev43}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: howler-client
-Version: 2.4.0.dev37
+Version: 2.4.0.dev43
 Summary: The Howler client library facilitates issuing requests to Howler
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs
@@ -37,25 +37,36 @@ The Howler client library facilitates issuing requests to Howler.
 
 ## Running the Tests
 
-1. Prepare the howler-api:
-   1. Start dependencies
-   1. `howler-api > python howler/app.py`
-   1. `howler-api > python howler/odm/random_data.py`
-2. Run python integration tests:
-   1. `python -m venv env`
-   1. `. env/bin/activate`
-   1. `pip install -r requirements.txt`
-   1. `pip install -r test/requirements.txt`
-   1. `pip install -e .`
-   1. `pytest -s -v test`
-
-## \_sqlite3 error
-
-You'll likely have to reinstall python3.9 while libsqlite3-dev is installed
-
-1. libsqlite3-dev
-   `sudo apt install libsqlite3-dev`
-2. Python3.9 with loadable-sqlite-extensions enabled
-   - `./configure --enable-loadable-sqlite-extensions --enable-optimizations`
-   - `make altinstall`
+### 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
+```
 

howler_client-2.4.0.dev43/README.md

@@ -0,0 +1,42 @@
+# 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
+```

{howler_client-2.4.0.dev37 → howler_client-2.4.0.dev43}/pyproject.toml

@@ -91,7 +91,7 @@ suppress-none-returning = true
 [tool.poetry]
 package-mode = true
 name = "howler-client"
-version = "2.4.0.dev37"
+version = "2.4.0.dev43"
 description = "The Howler client library facilitates issuing requests to Howler"
 authors = [
     "Canadian Centre for Cyber Security <howler@cyber.gc.ca>",

howler_client-2.4.0.dev37/README.md

@@ -1,31 +0,0 @@
-# Howler Client Library
-
-The Howler client library facilitates issuing requests to Howler.
-
-## Requirements
-
-1. Python 3.9 and up
-
-## Running the Tests
-
-1. Prepare the howler-api:
-   1. Start dependencies
-   1. `howler-api > python howler/app.py`
-   1. `howler-api > python howler/odm/random_data.py`
-2. Run python integration tests:
-   1. `python -m venv env`
-   1. `. env/bin/activate`
-   1. `pip install -r requirements.txt`
-   1. `pip install -r test/requirements.txt`
-   1. `pip install -e .`
-   1. `pytest -s -v test`
-
-## \_sqlite3 error
-
-You'll likely have to reinstall python3.9 while libsqlite3-dev is installed
-
-1. libsqlite3-dev
-   `sudo apt install libsqlite3-dev`
-2. Python3.9 with loadable-sqlite-extensions enabled
-   - `./configure --enable-loadable-sqlite-extensions --enable-optimizations`
-   - `make altinstall`