Metadata-Version: 2.1
Name: vpype-rerun
Version: 0.1.0a0
Summary: Rerun viewer integration for vpype
License: MIT
Author: Antoine Beyeler
Author-email: abeyeler@ab-ware.com
Requires-Python: >=3.9,<3.12
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Plugins
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Multimedia :: Graphics
Requires-Dist: click (>=8.1.6)
Requires-Dist: rerun-sdk (>=0.8.0)
Requires-Dist: vpype[all] (>=1.13)
Description-Content-Type: text/markdown

# vpype-rerun

[`vpype`](https://github.com/abey79/vpype) plug-in to [_to be completed_]


## Examples

_to be completed_


## Installation

See the [installation instructions](https://vpype.readthedocs.io/en/latest/install.html) for information on how
to install `vpype`.

If *vpype* was installed using pipx, use the following command:

```bash
$ pipx inject vpype vpype-rerun
```

If *vpype* was installed using pip in a virtual environment, activate the virtual environment and use the following command:

```bash
$ pip install vpype-rerun
```

Check that your install is successful:

```
$ vpype rerun --help
[...]
```

## Documentation

The complete plug-in documentation is available directly in the CLI help:

```bash
$ vpype rerun --help
```


## Development setup

Here is how to clone the project for development:

```bash
$ git clone https://github.com/abey79/vpype-rerun.git
$ cd vpype-rerun
```

Create a virtual environment:

```bash
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install --upgrade pip
```

Install `vpype-rerun` and its dependencies (including `vpype`):

```bash
$ pip install -e .
$ pip install -r dev-dependencies.txt
```


## License

See the [LICENSE](LICENSE) file for details.

