# venvtools
A simple setuptools command to help with virtualenv
# DEPRECATED
Use either [poetry](https://github.com/python-poetry/poetry) or [pipx](https://github.com/pypa/pipx) according to your use case.
### 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-2023 Vítor Vasconcellos. All rights reserved.
Raw data
{
"_id": null,
"home_page": "https://github.com/HeavenVolkoff/venvtools",
"name": "venvtools",
"maintainer": "V\u00edtor Vasconcellos",
"docs_url": null,
"requires_python": "~=3.6",
"maintainer_email": "vasconcellos.dev@gmail.com",
"keywords": "venv,command,distutils,setuptools",
"author": "V\u00edtor Vasconcellos",
"author_email": "vasconcellos.dev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/45/f4/2baa33cd8901a7be9d2ffb1443474a5d5c1805054e0e5f03e2fb62732887/venvtools-2.0.0.tar.gz",
"platform": null,
"description": "# venvtools\n\nA simple setuptools command to help with virtualenv\n\n# DEPRECATED\n\nUse either [poetry](https://github.com/python-poetry/poetry) or [pipx](https://github.com/pypa/pipx) according to your use case.\n\n### Motivation\n\nThe objective of this utility is to provide means for easy creation of a virtual\nenvironment for local packages using python's standard venv module and to integrate\nwith setuptools distribution model for seamless resolution and installation of\ndependencies.\n\n### How to use\n\nInside your package root folder execute the following to create the venv and install\nyour package dependencies inside it:\n```shell\npython ./setup.py venv\n```\nor (if your `setup.py` is executable)\n```shell\n./setup.py venv\n```\n\n> Currently updating dependencies inside the venv is not working correctly.\n> It's recommended to recreate the venv to archive it.\n>\n> (This will be fixed in a posterior version)\n```shell\n./setup.py venv --rm && ./setup.py venv\n```\n\n#### Options\n```\n--env-name (-n) Virtual environment name.\n (DEFAULT: Project name)\n--get-pip Virtual env get-pip.py URL.\n (DEFAULT: https://bootstrap.pypa.io/get-pip.py)\n--extras (-e) Comma separated list of extras to be installed.\n--system-site-packages Make the system (global) site-packages dir available to the\n created environment.\n--rm Remove virtual environment.\n--editable Install package to venv as editable.\n--location (-l) Retrieve virtual environment location.\n--old-resolver Force pip to use its old resolver.\n```\n\n### License\n\nSee [LICENSE](./LICENSE)\n\n### COPYRIGHT\n\n Copyright (c) 2018-2023 V\u00edtor Vasconcellos. All rights reserved.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A simple setuptools command to help with virtualenv",
"version": "2.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/HeavenVolkoff/venvtools/issues",
"Download": "https://github.com/HeavenVolkoff/venvtools/archive/master.zip",
"Homepage": "https://github.com/HeavenVolkoff/venvtools",
"Source Code": "https://github.com/HeavenVolkoff/venvtools"
},
"split_keywords": [
"venv",
"command",
"distutils",
"setuptools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "45f42baa33cd8901a7be9d2ffb1443474a5d5c1805054e0e5f03e2fb62732887",
"md5": "db5323d818f90c821255730664179e33",
"sha256": "039f98704fc2dc0ada7e2e825eb927361a14402cf5ed49851187238fbcbbb5c7"
},
"downloads": -1,
"filename": "venvtools-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "db5323d818f90c821255730664179e33",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.6",
"size": 7586,
"upload_time": "2023-10-06T05:33:33",
"upload_time_iso_8601": "2023-10-06T05:33:33.282097Z",
"url": "https://files.pythonhosted.org/packages/45/f4/2baa33cd8901a7be9d2ffb1443474a5d5c1805054e0e5f03e2fb62732887/venvtools-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-06 05:33:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "HeavenVolkoff",
"github_project": "venvtools",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "venvtools"
}