Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
enable-cache: true

- name: Install dependencies
run: uv sync --frozen
run: uv sync --all-extras --frozen

- name: Ruff check
run: uv run ruff check .
Expand Down Expand Up @@ -76,7 +76,7 @@ jobs:
cache-suffix: py${{ matrix.python-version }}

- name: Install dependencies
run: uv sync --frozen
run: uv sync --all-extras --frozen

- name: Run tests
run: uv run pytest tests/unit
2 changes: 1 addition & 1 deletion .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
enable-cache: true

- name: Install dependencies
run: uv sync --frozen
run: uv sync --all-extras --frozen

- name: Run tests with coverage
id: tests
Expand Down
3 changes: 3 additions & 0 deletions docs/api/surfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Built-in injectable surfaces.

!!! note
`OneDriveSurface` requires the `onedrive` extra: `pip install "rampart[onedrive]"`.

::: rampart.surfaces
options:
members:
Expand Down
26 changes: 25 additions & 1 deletion docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,31 @@ pip install -e .
For development dependencies (linting, type checking, test tooling):

```bash
pip install -e ".[dev]"
# uv (recommended — installs the dev group by default)
uv sync

# pip
pip install -e . --group dev
```

---

## Optional Extras

RAMPART's core install is intentionally small. Features that pull in heavy provider SDKs are exposed as optional extras:

| Extra | Pulls in | When you need it |
|-------|----------|------------------|
| `onedrive` | `msgraph-sdk`, `azure-identity` | Using the built-in [`OneDriveSurface`][rampart.surfaces.onedrive.OneDriveSurface] to plant XPIA payloads in OneDrive. |

Install one or more extras with the standard bracket syntax:

```bash
pip install "rampart[onedrive]"
# or from source:
pip install -e ".[onedrive]"
# or with uv:
uv add "rampart[onedrive]"
```

---
Expand Down
13 changes: 7 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,19 @@ classifiers = [
"Topic :: Software Development :: Testing",
]
dependencies = [
"azure-identity>=1.25.3",
"azure-kusto-data>=6.0.3",
"azure-kusto-ingest>=6.0.3",
"jsonschema>=4.26.0",
"msgraph-sdk>=1.55.0",
"playwright>=1.58.0",
"jinja2>=3.1.6",
"pyrit==0.13.0",
"pytest>=9.0.3",
"pytest-asyncio>=1.3.0",
"pyyaml>=6.0.3",
]

[project.optional-dependencies]
onedrive = [
"msgraph-sdk>=1.57.0",
"azure-identity>=1.25.3"
]

[dependency-groups]
dev = [
"pre-commit>=4.5.1",
Expand Down
Loading
Loading