Pre-release
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
Metadata
1 maintainer
Release files for clue-api 1.6.0.dev373
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| clue_api-1.6.0.dev373.tar.gz | 126.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| clue_api-1.6.0.dev373-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 291.3 kB
Release files / clue_api-1.6.0.dev373.tar.gz
| Download URL | clue_api-1.6.0.dev373.tar.gz |
|---|---|
| Size | 126.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
37adbfb43796df3cbb5759ddcffc00a511aa770bc5a470b9936fcd45b8c45621
|
|
BLAKE2b-256 checksum How to use checksums |
cd269e2dfd341a7f1b511716dc2f33e1126f7b1ed2a19ff533cc90df1fc3bdfc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.2 CPython/3.12.3 Linux/6.17.0-1022-azure
|
Release files / clue_api-1.6.0.dev373-py3-none-any.whl
| Download URL | clue_api-1.6.0.dev373-py3-none-any.whl |
|---|---|
| Size | 165.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
45a911ed64f5ffa6449403896fbe7673393be5599cc25a0e10af2247f9fddd68
|
|
BLAKE2b-256 checksum How to use checksums |
f0fb122ec409b8db29142f9c55bf1528fdd05ced5ed65eefb5a10974684d09b6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.2 CPython/3.12.3 Linux/6.17.0-1022-azure
|
