Metadata-Version: 2.1
Name: pyromania
Version: 1.0.0.dev4
Summary: Pyromania creates and manages Python 3 venvs, inspired by virtualenvwrapper.
Author-email: Tim Allen <tallen@wharton.upenn.edu>
License: BSD-3-Clause
Project-URL: Homepage, https://github.com/FlipperPA/pyromania/
Project-URL: Repository, https://github.com/FlipperPA/pyromania/
Project-URL: Documentation, https://github.com/FlipperPA/pyromania/
Project-URL: Bug Tracker, https://github.com/FlipperPA/pyromania/issues
Keywords: venv,virtualenv,virtual environment,docker,container
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.3
Description-Content-Type: text/markdown

# Pyromania venv Manager

Pyromania helps make venv management straightforward, inspired by `virtualenvwrapper`. By default, Pyromania will create a venv named `venv` in the current directory, and:

* Install the latest versions of `pip` and `wheel`.
* Includes handy options for switching to the `site-packages` folder.
* Creates pre and post activation hook scripts for additional customization.
* Activating your `venv` will automagically move to your project directory with a default pre-activation hook.

## System Wide Installation

To install the `pyro` command for all users on your system with sudo escalation:

```bash
curl -sS https://raw.githubusercontent.com/FlipperPA/pyromania/main/install-sudo.sh | sh
```

[An Ansible role for installation is also available.](https://github.com/FlipperPA/pyromania/tree/main/ansible-role-install)

## User Installation

To install the `pyro` command for the current user only:

```bash
curl -sS https://raw.githubusercontent.com/FlipperPA/pyromania/main/install.sh | sh
```

## Usage

**Options:**

* `--help`, `-h`: Display the help menu.
* `--delete`, `-d`: Delete the venv.
* `--create`, `-c`: Create the venv without prompting.
* `--packages` `-p`: Change to the venv's site-packages directory.

**Examples:**

* `pyro`: Lists the venvs currently managed by pyromania.
* `pyro my_venv`: Activate a venv called `my_venv`, or prompts to create it if it doesn't exist.
* `pyro my_venv -c`: Creates a venv called `my_venv` without prompting.
* `pyro my_venv --delete`: Deletes a venv called `my_venv`.
* `pyro my_venv -p`: Change to to the venv's site-packages directory.

## Settings

* `VENV_DIR` (default: `venv`): default venv directory name.
* `VENV_PYTHON` (default: `python3`): the default version of Python to include.

## Pre and Post Activation Hooks

Pyromania will create two hook files in your `venv` which can be modified for pre and post activation actions:

* `venv/pre_activate.sh`: script is run before the `venv` is activated.
* `venv/post_activate.sh`: script is run after the `venv` is activated.
