Contents

• 1   Repositories
  • 1.1   Distributions
  • 1.2   Source code
• 2   Usage
• 3   Hacking
  • 3.1   Development environment
  • 3.2   Run test suite
  • 3.3   Build and package

1   Repositories

1.1   Distributions

• https://pypi.org/project/ve/

1.2   Source code

• https://gitlab.com/sinoroc/ve
• https://github.com/sinoroc/ve

2   Usage

$ ve -h
usage: ve [-h] [--version] [directory]

positional arguments:
  directory   create the virtual environment in this directory (default .venv)

optional arguments:
  -h, --help  show this help message and exit
  --version   show program's version number and exit

3   Hacking

This project makes extensive use of tox, pytest, and GNU Make.

3.1   Development environment

Use following command to create a Python virtual environment with all necessary dependencies:

tox --recreate -e develop

This creates a Python virtual environment in the .tox/develop directory. It can be activated with the following command:

. .tox/develop/bin/activate

3.2   Run test suite

In a Python virtual environment run the following command:

make review

Outside of a Python virtual environment run the following command:

tox --recreate

3.3   Build and package

In a Python virtual environment run the following command:

make package

Outside of a Python virtual environment run the following command:

tox --recreate -e package