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.7.0.dev450
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| clue_api-1.7.0.dev450.tar.gz | 134.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| clue_api-1.7.0.dev450-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 309.4 kB
Release files / clue_api-1.7.0.dev450.tar.gz
| Download URL | clue_api-1.7.0.dev450.tar.gz |
|---|---|
| Size | 134.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a00c5c07c4b26157b2b128b3fd4e01a5d309b3e3a3f7c74521e8855388899050
|
|
BLAKE2b-256 checksum How to use checksums |
222b20cbfc174f44b5d034b30346cd05c88a3053a2bb80ba5f10152a2144bb6b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.12.3 Linux/6.17.0-1022-azure
|
Release files / clue_api-1.7.0.dev450-py3-none-any.whl
| Download URL | clue_api-1.7.0.dev450-py3-none-any.whl |
|---|---|
| Size | 174.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ab60a105531880d63fed091c646c494323ce290c4cd4a8da6842c2e3cfdca5ec
|
|
BLAKE2b-256 checksum How to use checksums |
491cf8ff05eeeb61124fe64598b89874b10eabc14f97c8c4001346bc69578b9b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.12.3 Linux/6.17.0-1022-azure
|
Security for clue-api 1.7.0.dev450
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
