https://github.com/mrmathematica/venv-pack2
Package virtual environments for redistribution
https://github.com/mrmathematica/venv-pack2
venv venv-python
Last synced: about 1 month ago
JSON representation
Package virtual environments for redistribution
- Host: GitHub
- URL: https://github.com/mrmathematica/venv-pack2
- Owner: mrmathematica
- License: bsd-3-clause
- Created: 2022-07-01T13:17:31.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-10T13:31:59.000Z (12 months ago)
- Last Synced: 2024-12-25T19:24:53.782Z (9 months ago)
- Topics: venv, venv-python
- Language: Python
- Homepage:
- Size: 105 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Venv-Pack
This is based on [venv-pack](https://github.com/jcrist/venv-pack) but with lots of improvements added by
[mrmathematica](https://github.com/mrmathematica/). It has Windows support. Bin/Scripts generated by venv will
work out-of-box.
Venv-pack is a command-line tool for packaging virtual environments for distribution. This is useful for deploying code
in a consistent environment.
Supports virtual environments created using python3/venv. Venv is part of the python standard library.
## Install from source
venv-pack is available on github and can always be installed from source.
```
pip install git+https://github.com/mrmathematica/venv-pack.git
```
## Install from pypi
venv-pack is available on pypi as `venv-pack2`.
```
pip install venv-pack2
```
## Command-line Usage
One common use case is packing an environment on one machine to distribute to other machines as part of a deployment
process.
### On the source machine
Create venv, and then upgrade pip + setuptools first:
```
python -m venv venv
venv\Scripts\activate
python -m pip install -U pip setuptools
```
Python generates Windows .exe file such as pip.exe on the fly, so on Windows there is restriction that you want to fix a
version of pip and setuptools at the beginning and stick with it. If needed, re-create new venv from a lock file. See
[pip-tools](https://github.com/jazzband/pip-tools).
Install all your python packages, for example
```
pip install -r requirements.txt
```
Pack the current environment into my_env.zip
```
venv-pack -o env.zip
```
Pack an environment located at an explicit path into my_env.zip
```
venv-pack -p explicit\path\to\env -o env.zip
```
### On the target machine
Unpack environment into directory `my_env`
```
md my_env
python -m zipfile -e venv.zip my_env\
```
All features of venv should keep working from my_env folder.
## Caveats
This tool is new, and has a few caveats.
1. Python is not packaged with the environment, but rather symlinked in the environment. On Windows python venv does so in a pyvenv.cfg file. This is useful for deployment situations where Python is already installed on the machine, but the required library dependencies may not be.
2. The os type where the environment was built must match the os type of the target. This means that environments built on windows can’t be relocated to linux.