This release is a pre-release and may not be stable for production use.
Clue
To start the API for clue, check to ensure that:
- Docker is composed up through
dev/docker-compose.yml cd clue/api- Run
poetry installwithin the clue/api folder to install all dependencies - You may need to run
poetry install --with test,dev,types,plugins --all-extras - Run
sudo mkdir -p /var/log/clue/ - Run
sudo mkdir -p /etc/clue/conf/ - Run
sudo chmod a+rw /var/log/clue/ - Run
sudo chmod a+rw /etc/clue/conf/ - Run
cp build_scripts/classification.yml /etc/clue/conf/classification.yml - Run
cp test/unit/config.yml /etc/clue/conf/config.yml - To start server:
poetry run server
To start Enrichment Testing:
- In order to have the local server connect to the UI the servers need to be ran manually
- Please ensure that
pwdis clue/api - May need to add
poetry runbefore each command
flask --app test.utils.test_server run --no-reload --port 5008flask --app test.utils.bad_server run --no-reload --port 5009flask --app test.utils.slow_server run --no-reload --port 5010flask --app test.utils.telemetry_server run --no-reload --port 5011
Troubleshooting:
- If there are issues with these steps please check the build system for poetry installation steps
- The scripts will show all necessary directories that need to be made in order for classfication to work
Contributing
See CONTRIBUTING.md for more information
FAQ
I'm getting permissions issues on /var/log/clue or /etc/clue/conf?
Run sudo chmod a+rw /var/log/clue/ and sudo chmod a+rw /etc/clue/conf/.
How can I add dependencies for my plugin?
See this section of CONTRIBUTING.md.
Email rendering does not seem to be working?
You must install wkhtmltopdf, both locally for development and in your Dockerfile:
sudo apt install wkhtmltopdf
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file clue_api-1.5.1.dev319.tar.gz.
File metadata
- Download URL: clue_api-1.5.1.dev319.tar.gz
- Upload date:
- Size: 124.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9d34e6b5a62f6be08441cb8da5cfa786812a3d4c15eae4c88d911dc157b4b865
|
|
| MD5 |
f2e51f12ca165614636d62447175ab48
|
|
| BLAKE2b-256 |
63db2a419624a39c63a12cf5e23849e3cd9ad50bf7f2149ad00a67c6fbb00e24
|
File details
Details for the file clue_api-1.5.1.dev319-py3-none-any.whl.
File metadata
- Download URL: clue_api-1.5.1.dev319-py3-none-any.whl
- Upload date:
- Size: 163.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
174bc07e32914179886224399c3e60bde369222991da157c454d7d57df2c5446
|
|
| MD5 |
d335124f37027bc2e88bfea236145150
|
|
| BLAKE2b-256 |
b298b56ce41f318d60e599d0561b28762286bf513231f6c609a9e8c15ef54ed3
|
