xvenv

xvenv.py helps to setup and maintain a venv quickly

xvenv.py can be installed with pip, or it runs as single stand-alone script.

when installed via pip the command execution python3 xvenv.py can be replaced just by xvenv.

use-case: try a new application from pypi

run

xvenv setup
xvenv pip
xvenv tools -tool *the-package*

or just as single command

xvenv make --quick -tool *the-package*

so xvenv will create a folder .venv, and will do there all required steps.

then its possible to start either with normal venv

source ./bin/activate
# end start manually
*the-package-commandline*

or

xvenv run *the-package-commandline*

desktop starter

when done the steps above and the package starts e.g. a desktop starter can be created with

/usr/bin/python3 xvenv.py -cwd /your-path run *the-package-commandline*

installation

pip

it's recommended to install from pip with

pip install xvenv

stand-alone or clone

put this in ~/.bashrc, or ~/.bash_aliases

alias xvenv="python3 ~/repo/xvenv/xvenv/xvenv.py"

# or ... any path where the script resides in

to use it from cmd-line

use case: build a whole source package

e.g. when testing a build and installation where all sources are inside a single folder on the harddrive already. then cd into it and

run

xvenv setup
xvenv pip -u    # this will install and upgrade pip 
xvenv tools -u  # this will install and upgrade setuptools, twine, wheel, black, flake8 
xvenv req       # this will install from requirements.txt with pip  
xvenv test
xvenv build  
xvenv install

or just as single command

xvenv make -u 

what will install the sources as editable inside the venv.

then activate venv manually, or start the tool as described above.

use-case: new development

think about having started a new development, and now its required to have a venv in addition to encapsulate the dependencies.

run

xvenv setup
xvenv pip -u 
xvenv tools -u  
xvenv req   

or just as single command

xvenv make -q -u 

what will create the venv, then install pip, setuptools, twine, black, and flake8

as soon the make related steps are done, test with

xvenv build
xvenv install

or just as single command

xvenv binst

what will call setup sdist build bdist_wheel internally, followed by pip install -e .

single steps vs make and binst

the table below shows how single steps and the combined tools (make and binst) are related.

see also all cmd-line opts here: README_CMDLINE

need more packages ?

run

xvenv tools -tool *pack1* *pack2* ...

or

xvenv tools -tool *pack1* *pack2* ... -u
    -> to update the tools packages

or alternative

xvenv run pip install *pack1* *pack2* ... -U

to install more packages into the venv

removing a venv

a .venv folder can be deleted manuall if the venv is not required anymore. there are no further dependencies.

or run

 xvenv drop

another use case: install thonny and thonny-gitonic

open a new bash and run

mkdir thonnygitonic
cd $_
xvenv -V make -q -u -tool thonny thonny-gitonic

what will do a quick make (just install packackges into the venv) with an upgrade of the packages and print verbose output

then run

xvenv run thonny

another use case: using venv installed tools - formating with black

assuming a venv with default tools setup

mkdir ~/sample
cd $_
xvenv -V make -q -u
cd *another-folder*
xvenv -venv ~/sample/ -d run black .
    # -> will run black from the venv in the current folder

(* -venv is new in version v0.0.3, but with absoulte path for black it works in v.0.0.2)

xvenv run COMMAND with -cwd and -venv explained

the execution with options -cwd and -venv is equivalent to:

# activate venv 
source "$VENV/bin/activate"

# cd into working folder
cd "$CWD"

# execute the command
$COMMAND

all cmd-line opts

all cmd-line opts are described here README_CMDLINE

what's new ?

check CHANGELOG for latest ongoing, or upcoming news.

limitations

check BACKLOG for open development tasks and limitations.

platform

as of now just linux

Contributiors are welcome to helping with Windows and Mac !!!

development status

alpha, the interface/ workflow might change without prior notice

further readings

there are also some other tools available addressing somehow the same topic but with a different scope of functionality.

• pipenv
• hatch

license

this software is free for non-commercial use. LICENSE