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.5.0.dev229
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.5.0.dev229.tar.gz | 111.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| clue_api-1.5.0.dev229-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 259.2 kB
Release files / clue_api-1.5.0.dev229.tar.gz
| Download URL | clue_api-1.5.0.dev229.tar.gz |
|---|---|
| Size | 111.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0af03ab9d8c9e90b6635911c49bc2efdab3775a4129ed4a48dad740bec9748b0
|
|
BLAKE2b-256 checksum How to use checksums |
b9dbe7fd697f92dad20c5f4bbbe28e9e3c4982ac098c6331aa3bbc77ff87d395
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.12.3 Linux/6.14.0-1017-azure
|
Release files / clue_api-1.5.0.dev229-py3-none-any.whl
| Download URL | clue_api-1.5.0.dev229-py3-none-any.whl |
|---|---|
| Size | 148.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
07305c5a0c2cd6f38a98039a0c4d7528274ded7ab0dfad46823f33ccc7208a84
|
|
BLAKE2b-256 checksum How to use checksums |
b340dffe29cdbe5b15269665cea2bed69b003173e4cf4cecd8bb1708656def73
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.12.3 Linux/6.14.0-1017-azure
|
