Usage

In order to use buildenv tool features, please follow these instructions.

Project already configured with buildenv

Any project already using the buildenv tool has generated loading scripts in its root folder.
The typical project setup scenario with buildenv is:

  1. clone the project – git clone git@github.com:xxx/yyy.git

  2. launch the loading script:

    • on Linux (or git bash): ./buildenv.sh

    • on Windows: buildenv.cmd

  3. build the project; the build environment (i.e. python venv + extensions) is now installed and loaded in your terminal

Install buildenv in a new/existing project

Any project can be simply setup to use buildenv, by following one of these methods:

Global user install

buildenv tool can be temporarily installed as a shared user command using pipx:

pipx run buildenv

So it’s possible to use the pipx run buildenv init --new <path> command to bootstrap a new build environment in the specified folder.

Then, just run the generated loading script for your preferred shell to load the new build environment.

Script install

  1. download main python loading script:

    • use your browser right-click > save link as feature on the above link

    • or on Linux, run wget https://raw.githubusercontent.com/dynod/buildenv/main/buildenv-loader.py

  2. launch the script:

    • on Linux: python3 buildenv-loader.py

    • on Windows: python buildenv-loader.py

  3. you’re done, loading scripts are generated in your project