Metadata-Version: 2.4
Name: posit-vip
Version: 0.24.6
Summary: Verified Installation of Posit - An extensible test suite for validating Posit Team deployments
Project-URL: Homepage, https://posit-dev.github.io/vip/
Project-URL: Repository, https://github.com/posit-dev/vip
Project-URL: Documentation, https://posit-dev.github.io/vip/getting-started/
Project-URL: Changelog, https://github.com/posit-dev/vip/blob/main/CHANGELOG.md
Author-email: Elliot Murphy <elliot.murphy@posit.co>, Ian Flores Siaca <iflores.siaca@posit.co>
License: MIT License
        
        Copyright (c) 2026 posit-dev
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Requires-Dist: brand-yml
Requires-Dist: htmltools
Requires-Dist: httpx<1,>=0.27
Requires-Dist: playwright>=1.40
Requires-Dist: pygments>=2.20.0
Requires-Dist: pytest-bdd>=7.0
Requires-Dist: pytest-playwright>=0.5
Requires-Dist: pytest-xdist>=3.0
Requires-Dist: pytest>=9.0.3
Requires-Dist: python-multipart>=0.0.26
Requires-Dist: requests>=2.33.0
Requires-Dist: shiny[theme]>=1.0
Requires-Dist: tomli>=2.0; python_version < '3.11'
Provides-Extra: cluster
Requires-Dist: azure-identity>=1.12; extra == 'cluster'
Requires-Dist: azure-mgmt-containerservice>=20.0; extra == 'cluster'
Requires-Dist: boto3>=1.26; extra == 'cluster'
Requires-Dist: cryptography>=46.0.7; extra == 'cluster'
Requires-Dist: pyjwt>=2.12.0; extra == 'cluster'
Requires-Dist: pyyaml>=6.0; extra == 'cluster'
Provides-Extra: dev
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: pip-audit>=2.7; extra == 'dev'
Requires-Dist: pytest-cov>=6.0; extra == 'dev'
Requires-Dist: ruff<0.16,>=0.15.0; extra == 'dev'
Requires-Dist: types-pyyaml>=6.0; extra == 'dev'
Provides-Extra: load
Requires-Dist: locust>=2.20; extra == 'load'
Provides-Extra: report
Requires-Dist: ipykernel; extra == 'report'
Requires-Dist: jinja2>=3.1; extra == 'report'
Requires-Dist: jupyter; extra == 'report'
Requires-Dist: nbclient>=0.8; extra == 'report'
Requires-Dist: nbformat>=5.7; extra == 'report'
Requires-Dist: tornado>=6.5.5; extra == 'report'
Description-Content-Type: text/markdown

[![PyPI](https://img.shields.io/pypi/v/posit-vip)](https://pypi.org/project/posit-vip/)
[![CI](https://github.com/posit-dev/vip/actions/workflows/ci.yml/badge.svg)](https://github.com/posit-dev/vip/actions/workflows/ci.yml)
[![Python](https://img.shields.io/pypi/pyversions/posit-vip)](https://pypi.org/project/posit-vip/)

# VIP - Verified Installation of Posit

An open-source, extensible test suite that validates Posit Team deployments are
installed correctly and functioning properly.

VIP uses **BDD-style tests** (pytest-bdd + Playwright) to verify Connect,
Workbench, and Package Manager.  Results are compiled into an **HTML report**
that can be published to a Connect server.

**Documentation:** https://posit-dev.github.io/vip/

## Quick start

```bash
uv pip install posit-vip
uv run playwright install chromium
vip verify --connect-url https://connect.example.com --interactive-auth
```

On a headless server (no display), use `--headless-auth` instead:

```bash
vip verify --config vip.toml --headless-auth
```

Run a specific test by name:

```bash
vip verify --connect-url https://connect.example.com --filter test_login
```

With a configuration file:

```bash
cp vip.toml.example vip.toml     # edit with your deployment details
vip verify --config vip.toml
```

## CLI commands

| Command | Description |
|---|---|
| `vip verify` | Run verification tests against a Posit Team deployment |
| `vip status` | Quick health check for each configured product |
| `vip cleanup` | Delete VIP test credentials and resources |
| `vip report` | Render the HTML report from test results (requires [Quarto CLI](https://quarto.org/docs/download/)) |
| `vip app` | Launch the Shiny GUI for interactive test running |
| `vip auth` | Authentication tools (e.g. mint Connect API keys) |
| `vip cluster` | Cluster connection tools for Kubernetes deployments |

Run `vip --help` or `vip <command> --help` for full usage details.

## Shiny app (graphical test runner)

VIP includes a Shiny for Python app that lets you select test categories,
run tests, and view the report — all from a browser.  This is especially
convenient inside a Posit Workbench session (RStudio or Positron) where
the app opens in the Viewer pane.

```bash
uv run vip app
```

See the [Shiny App guide](https://posit-dev.github.io/vip/shiny-app/) for details.

## Development

See [docs/development.md](docs/development.md) for dev setup, linting, and formatting.

For the test architecture and four-layer design, see [docs/test-architecture.md](docs/test-architecture.md).

## License

MIT — see [LICENSE](LICENSE).
