semvec/pypi-packages huggingface dataset:
theprelude 0.9.6
For interacting with the Prelude API
Requires Python: >=3.8

# The Prelude

This library can do the following:
1. Turn any code base into a security probe (Probe module)
2. Manage your Prelude Detect account (Account module)

## Probe module

### Setup
1. Use the Account module to register a new probe, which will return you a security token.
2. Set the token as an environment variable named PRELUDE_TOKEN (shown below).

### Usage guide

Add this snippet anywhere in your code base to start a probe.

```python
from theprelude.sdk.detect_sdk import enable_probe
enable_probe()
```

How it works:
- A new endpoint token is registered with the systems hostname
- The probe is downloaded into the application's process space.
- It runs as long as the application is alive.


### Command line utility

There is a built-in command-line program that allows easy access to the Detect API. The CLI is modeled after the `aws-cli` 
package in terms of how it works.

First install the package with:
```python
pip install theprelude
```

Then view the available CLI tools with:
```bash
detect --help
```

## Developer guide

Make changes then install locally before testing:
```
pip install .
```

To publish a new version on [PyPy](https://pypi.org/project/theprelude/):
```commandline
python -m build
python -m twine upload --repository pypi dist/*
```