Metadata-Version: 2.1
Name: venvtools
Version: 1.0.1
Summary: A simple setuptools command to help with virtualenv
Home-page: https://github.com/HeavenVolkoff/venvtools
Author: Vítor Vasconcellos
Author-email: vasconcellos.dev@gmail.com
Maintainer: Vítor Vasconcellos
Maintainer-email: vasconcellos.dev@gmail.com
License: BSD-3-Clause
Download-URL: https://github.com/HeavenVolkoff/venvtools/archive/master.zip
Project-URL: Source Code, https://github.com/HeavenVolkoff/venvtools
Project-URL: Bug Tracker, https://github.com/HeavenVolkoff/venvtools/issues
Keywords: venv,command,distutils,setuptools
Platform: UNKNOWN
Classifier: Framework :: Setuptools Plugin
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: BSD License
Requires-Python: ~=3.6
Description-Content-Type: text/markdown; charset=UTF-8
Requires-Dist: pip (>=20.3)
Requires-Dist: setuptools (>=45.0.0)
Requires-Dist: typing-extensions ; python_version < "3.8"
Requires-Dist: importlib-metadata ; python_version < "3.8"
Provides-Extra: dev
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: isort (~=5.0) ; extra == 'dev'
Provides-Extra: docs
Provides-Extra: tests
Requires-Dist: mypy ; extra == 'tests'

# venvtools

A simple setuptools command to help with virtualenv

### Motivation

The objective of this utility is to provide means for easy creation of a virtual
environment for local packages using python's standard venv module and to integrate
with setuptools distribution model for seamless resolution and installation of
dependencies.

### How to use

Inside your package root folder execute the following to create the venv and install
your package dependencies inside it:
```shell
python ./setup.py venv
```
or (if your `setup.py` is executable)
```shell
./setup.py venv
```

> Currently updating dependencies inside the venv is not working correctly.
> It's recommended to recreate the venv to archive it.
>
> (This will be fixed in a posterior version)
```shell
./setup.py venv --rm && ./setup.py venv
```

#### Options
```
--env-name (-n)         Virtual environment name.
                        (DEFAULT: Project name)
--get-pip               Virtual env get-pip.py URL.
                        (DEFAULT: https://bootstrap.pypa.io/get-pip.py)
--extras (-e)           Comma separated list of extras to be installed.
--system-site-packages  Make the system (global) site-packages dir available to the
                        created environment.
--rm                    Remove virtual environment.
--editable              Install package to venv as editable.
--location (-l)         Retrieve virtual environment location.
--old-resolver          Force pip to use its old resolver.
```

### License

See [LICENSE](./LICENSE)

### COPYRIGHT

    Copyright (c) 2018-2020 Vítor Augusto da Silva Vasconcellos. All rights reserved.


