venv-pack2

Name	venv-pack2 JSON
Version	0.9.1 JSON
	download
home_page	None
Summary	Package virtual environments for redistribution
upload_time	2024-10-10 13:58:11
maintainer	None
docs_url	None
author	None
requires_python	None
license	None
keywords	venv packaging portable
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage

# 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.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "venv-pack2",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": "mrmathematica <mrmathematica@yahoo.com>",
    "keywords": "venv, packaging, portable",
    "author": null,
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "# Venv-Pack\n\nThis is based on [venv-pack](https://github.com/jcrist/venv-pack) but with lots of improvements added by\n[mrmathematica](https://github.com/mrmathematica/). It has Windows support. Bin/Scripts generated by venv will\nwork out-of-box.\n\nVenv-pack is a command-line tool for packaging virtual environments for distribution. This is useful for deploying code\nin a consistent environment.\n\nSupports virtual environments created using python3/venv. Venv is part of the python standard library.\n\n## Install from source\n\nvenv-pack is available on github and can always be installed from source.\n\n```\npip install git+https://github.com/mrmathematica/venv-pack.git\n```\n\n## Install from pypi\n\nvenv-pack is available on pypi as `venv-pack2`.\n\n```\npip install venv-pack2\n```\n\n## Command-line Usage\n\nOne common use case is packing an environment on one machine to distribute to other machines as part of a deployment\nprocess.\n\n### On the source machine\n\nCreate venv, and then upgrade pip + setuptools first:\n```\npython -m venv venv\nvenv\\Scripts\\activate\npython -m pip install -U pip setuptools\n```\n\nPython generates Windows .exe file such as pip.exe on the fly, so on Windows there is restriction that you want to fix a\nversion of pip and setuptools at the beginning and stick with it. If needed, re-create new venv from a lock file. See\n[pip-tools](https://github.com/jazzband/pip-tools).   \n\nInstall all your python packages, for example\n```\npip install -r requirements.txt\n```\n\nPack the current environment into my_env.zip\n```\nvenv-pack -o env.zip\n```\n\nPack an environment located at an explicit path into my_env.zip\n```\nvenv-pack -p explicit\\path\\to\\env -o env.zip \n```\n\n### On the target machine\n\nUnpack environment into directory `my_env`\n```\nmd my_env\npython -m zipfile -e venv.zip my_env\\ \n```\n\nAll features of venv should keep working from my_env folder. \n\n## Caveats\n\nThis tool is new, and has a few caveats.\n\n1. 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.\n2. The os type where the environment was built must match the os type of the target. This means that environments built on windows can\u2019t be relocated to linux.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Package virtual environments for redistribution",
    "version": "0.9.1",
    "project_urls": {
        "Repository": "https://github.com/mrmathematica/venv-pack2.git"
    },
    "split_keywords": [
        "venv",
        " packaging",
        " portable"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2c14afdde459612c96c08d1e6853a156337d409533a2b35bb9ed9da87cf3ca49",
                "md5": "5ba7a3b6fa909690165ee614f165a947",
                "sha256": "bceebe8e9ee98bc8cd72b2becc1490aa494782dfd5ab02b1ad74fc3236b414fe"
            },
            "downloads": -1,
            "filename": "venv_pack2-0.9.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5ba7a3b6fa909690165ee614f165a947",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 22500,
            "upload_time": "2024-10-10T13:58:11",
            "upload_time_iso_8601": "2024-10-10T13:58:11.289578Z",
            "url": "https://files.pythonhosted.org/packages/2c/14/afdde459612c96c08d1e6853a156337d409533a2b35bb9ed9da87cf3ca49/venv_pack2-0.9.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-10 13:58:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mrmathematica",
    "github_project": "venv-pack2",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": false,
    "lcname": "venv-pack2"
}

None