Metadata-Version: 2.4
Name: prevalidate-cluster
Version: 0.1.0
Summary:     A language-agnostic dry-run tool that users can run on a cluster before      `sbatch`, that profiles their task and flags cluster-unfriendly behavior.
Project-URL: bugs, https://github.com/florence-bockting/prevalidate-cluster/issues
Project-URL: changelog, https://github.com/florence-bockting/prevalidate-cluster/releases
Project-URL: homepage, https://github.com/florence-bockting/prevalidate-cluster
Author-email: Florence Bockting <florence.bockting@aalto.fi>
Maintainer-email: Florence Bockting <florence.bockting@aalto.fi>
License: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: nvidia-ml-py
Requires-Dist: psutil
Requires-Dist: rich
Requires-Dist: typer
Description-Content-Type: text/markdown

# prevalidate-cluster

![PyPI version](https://img.shields.io/pypi/v/prevalidate-cluster.svg)

A language-agnostic dry-run tool that users can run on a cluster before
`sbatch`, that profiles their task and flags cluster-unfriendly behavior

* [GitHub](https://github.com/florence-bockting/prevalidate-cluster/) 
<!--
| [PyPI](https://pypi.org/project/prevalidate-cluster/) | [Documentation](https://florence-bockting.github.io/prevalidate-cluster/)
-->
* Created by [Florence Bockting](https://florence-bockting.github.io) | 
GitHub [@florence-bockting](https://github.com/florence-bockting)
* MIT License

Install with `pip install prevalidate-cluster` (or `uv add prevalidate-cluster`),
then import as `prevc`.

## Features

* TODO

## Documentation

Documentation is built with [Zensical](https://zensical.org/) and deployed to
GitHub Pages.

* **Live site:** https://florence-bockting.github.io/prevalidate-cluster/
* **Preview locally:** `just docs-serve` (serves at http://localhost:8000)
* **Build:** `just docs-build`

API documentation is auto-generated from docstrings using
[mkdocstrings](https://mkdocstrings.github.io/).

Docs deploy automatically on push to `main` via GitHub Actions. To enable this,
go to your repo's Settings > Pages and set the source to **GitHub Actions**.

## Development

To set up for local development:

```bash
# Clone your fork
git clone git@github.com:your_username/prevalidate-cluster.git
cd prevalidate-cluster

# Install in editable mode with live updates
uv tool install --editable .
```

This installs the CLI globally but with live updates - any changes you make to
the source code are immediately available when you run `prevc`.

Run tests:

```bash
uv run pytest
```

Run quality checks (format, lint, type check, test):

```bash
just qa
```

## Author

prevalidate-cluster was created in 2026 by Florence Bockting.

Built with [Cookiecutter](https://github.com/cookiecutter/cookiecutter) and
the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.
