anti
214ce50941
- Add readme field to all three pyproject.toml files (populates PyPI description page) - Bump versions to 0.1.1 and update behave-core pin in shell/text - Update Install sections in root, BEHAVE-SHELL, and BEHAVE-TEXT READMEs to lead with pip install from PyPI - Add CHANGELOG.md at project root (Keep-a-Changelog format)
52 lines
1.4 KiB
Markdown
52 lines
1.4 KiB
Markdown
# BEHAVE
|
|
|
|
Behavioral observation spec for adversarial network attribution.
|
|
BEHAVE defines a structured observation envelope (`core`) and two domain registries — shell-session (`BEHAVE-SHELL`) and text/messaging (`BEHAVE-TEXT`) — used to build behavioral signatures over collected operator activity.
|
|
|
|
## Packages
|
|
|
|
| Package | Description | Path |
|
|
|---|---|---|
|
|
| `behave-core` | Shared observation envelope — schema contract used by all registries | [`core/`](core/) |
|
|
| `behave-shell` | Shell-session behavioral observation registry | [`BEHAVE-SHELL/`](BEHAVE-SHELL/) |
|
|
| `behave-text` | Text/messaging-domain behavioral observation registry | [`BEHAVE-TEXT/`](BEHAVE-TEXT/) |
|
|
|
|
## Install
|
|
|
|
All packages are available on PyPI:
|
|
|
|
```bash
|
|
pip install behave-core
|
|
pip install behave-shell
|
|
pip install behave-text
|
|
```
|
|
|
|
`behave-core` is pulled in automatically as a dependency of the registries.
|
|
|
|
For local development (includes pytest + ruff):
|
|
|
|
```bash
|
|
pip install -e "core/[dev]"
|
|
pip install -e "BEHAVE-SHELL/[dev]"
|
|
pip install -e "BEHAVE-TEXT/[dev]"
|
|
```
|
|
|
|
## Test
|
|
|
|
```bash
|
|
pytest core/
|
|
pytest BEHAVE-SHELL/
|
|
pytest BEHAVE-TEXT/
|
|
```
|
|
|
|
## Licensing
|
|
|
|
This repository uses a dual license:
|
|
|
|
| Content | License |
|
|
|---|---|
|
|
| Code, JSON schemas, tests (`*.py`, `*.json`, `pyproject.toml`) | [GNU GPL v3.0 or later](LICENSE) |
|
|
| Spec prose and attribution recipes (`*.md` files) | [CC-BY-SA-4.0](LICENSE.docs) |
|
|
|
|
SPDX identifiers are present in individual files.
|