virtualenv-cache 0.0.2

Installation

You can install the latest version from PyPI:

pip install virtualenv-cache

If you wish to run the latest version from the Git repository:

pip install git+https://github.com/fridex/virtualenv-cache@latest

Usage

First, there needs to be generated a configuration file:

virtualenv-cache init

The command above will create a configuration file in the current directory (by default) called .virtualenv_cache.toml. Check its configuration options as described below to match your desired behavior. This file has be generated per project that should be using the cache and should be part of the project code base - e.g. committed to the Git repository so that it can be used on a clone.

Next, your configuration in a CI can look similar to the code snipped bellow:

cd project-root/
virtualenv-cache restore
[ $? -eq 1 ] && ( python3 -m venv .venv && source .venv/bin/activate && pip install -r requirements.txt && virtualenv-cache store )

The code snipped above will try to restore a virtual environment from cache. If there is no matching cached virtual environment, the restore command exists with exit code of 1 indicating cache miss. In that case, the virtual environment can be created and prepared for the next runs which will result in a cache hit (unless there is a change in requirements files which results in a new virtual environment creation that will get cached again). Just make sure you keep all the requirements installed in your virtual environment and have them stated in requirements_lock_paths.

Configuration file

The configuration file can be generated using virtualenv-cache init. An example of such configuration file:

[virtualenv-cache]
cache_size = 25
cache_path = "${HOME}/.virtualenv-cache/my-project/cache/"
virtualenv_path = ".venv"
requirements_lock_paths = [
    "requirements.txt",
    "requirements-dev.txt",
    "requirements-typing.txt"
]

Commands

The tool can be run with the following sub-commands:

• virtualenv-cache store - store the curent virtual environment into the cache

• virtualenv-cache restore - restore the matching virtual environment from the cache

• virtualenv-cache init - initialize the configuration file

• virtualenv-cache list - list entries in the cache with their additional metadata, such as the last access time

• virtualenv-cache erase - drop all cached virtual environments

See --help for more information and options available.

Additional notes

All the CLI parameters can be supplied as environment variables:

• VIRTUALENV_CACHE_CONFIG_PATH - a path to the virtualenv-cache configuration file

• VIRTUALENV_CACHE_FORMAT - format used to print output to terminal

• VIRTUALENV_CACHE_WORK_DIR - a working directory for the CLI