Metadata-Version: 2.3
Name: poetry-plugin-exec
Version: 1.0.3
Summary: Poetry plugin to configure and execute commands like npm run.
Author: Marcos Alonso
Author-email: contact@marcosalonso.dev
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: poetry (>=2.1.0,<3.0.0)
Requires-Dist: poetry-core (>=2.1.0,<3.0.0)
Description-Content-Type: text/markdown

# Poetry Plugin: Exec

[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)


Poetry plugin to define and execute shell scripts in pyproject.toml file like npm run.

> [!IMPORTANT]  
> This plugin only works on Poetry versions >=2.1.0 installed on Python versions >=3.9!


## Installation

Install the `exec` plugin via the `poetry self add`:

```bash
poetry self add poetry-plugin-exec
```

## Usage

In the pyproject.toml file of your project, define the `[tool.poetry_plugin_exec.scripts]` section, adding your needed scripts:

```toml
[tool.poetry_plugin_exec.scripts]
check-format = "poetry run ruff check ."
```

Then, you can simply run the `poetry exec <script_name> command`:
```bash
poetry exec check-format
```



> [!NOTE]
> This plugin is based on examples from [the official Poetry repositories](https://github.com/python-poetry).
