PythonBootstrapper

This repository includes tools and scripts that install python locally in as consistent and benign as way as possible. Supports side-by-side installations for different versions of python and minimizes overhead through the use of virtual environments.

Using a PythonBootstrapper Repository
Creating a PythonBootstrapper Repository

Features

The bootstrapping process

1. Ensures that micromamba is available locally.
2. Ensures that Python is available locally.
3. Ensures that virtualenv is installed.
4. Creates a python virtual environment for your cloned repository.
5. Creates Activate and Decativate scripts for your cloned repository.
6. Invokes custom bootstrapping functionality defined in your repository.

...details removed...

The activation process

1. Activates micromamba.
2. Activates the python virtual environment.
3. Invokes custom activation functionality defined in your repository.

The deactivation process

1. Invokes custom deactivation functionality defined in your repository.
2. Deactivates the python virtual environment.
3. Deactivates micromamba.

Testing

All changes to this repository are validated GitHub runners across the MacOS, Ubuntu, and Windows operating systems using the Python versions:

Version	First Released	End of Support
3.12	October 2023	October 2028
3.11	October 2022	October 2027
3.10	October 2021	October 2026
3.9	October 2020	October 2025
3.8	October 2019	October 2024

Using a PythonBootstrapper Repository

To begin using a git repository leveraging PythonBootstrapper functionality, run the scripts defined here in the following sections.

Quick Start

Operating System	Scripts
Linux / MacOS	./Bootstrap.sh . ./Activate.sh . ./Deactivate.sh
Windows	Bootstrap.cmd Activate.cmd Deactivate.cmd

Bootstrap

The bootstrap process prepares your local machine for development activities. Once the process is complete, your local machine will have micromamba and python installed, a virtual python environment created under the ./Generated directory, and any custom bootstrap activities defined by the repository will have been run.

A repository will generally only need to be bootstrapped once after its is cloned.

Operating System	Script
Linux / MacOS	Bootstrap.sh [--python-version <version>] [--force] [--debug] [<any repository-specific arguments>]
Windows	Bootstrap.cmd [--python-version <version>] [--force] [--debug] [<any repository-specific arguments>]

Activate

The activation process prepares your local terminal environment for development activities. Once the process is complete, your terminal environment will have micromamba and python activated, and any custom activation activities defined by the repository will have been run.

Each terminal environment will need to be activated.

Operating System	Script
Linux / MacOS	Activate.sh [--verbose] [--debug] [<any repository-specific arguments>]
Windows	Activate.cmd [--verbose] [--debug] [<any repository-specific arguments>]

Deactivate

The deactivation process restores your local terminal environment to its state prior to activation. Once the process is complete, any custom deactivation activities defined by the repository will have been run, and your terminall will have micromamba and python deactivated.

A terminal environment can either be explicitly deactivated or simply closed.

Operating System	Script
Linux / MacOS	Deactivate.sh [--verbose] [--debug] [<any repository-specific arguments>]
Windows	Deactivate.cmd [--verbose] [--debug] [<any repository-specific arguments>]

Creating a PythonBootstrapper Repository

Any repository can leverage the functionality provided by PythonBootstrapper, including the creation of custom steps invoked during the bootstrap, activation, or deactivation processes.

Minimum Functionality

To use PythonBootstrapper functionality in your repository:

1. Copy ./Templates/Bootstrap.sh to the root of your repository (for Linux / MacOS support).
2. Copy ./Templates/Bootstrap.cmd to the root of your repository (for Windows support).
3. Copy ./Templates/.gitignore to the root of your repository (for git support).

Complete the steps in the following sections to customize the bootstrap, activation, or deactivation processes.

Customization

There are 2 ways to customize the bootstrap, activation, or deactivation processes:

1. Add operating-system-specific functionality to <Bootstrap|Activate|Deactivate>Epilog<.sh|.cmd>.
2. Implement custom functionality in <Bootstrap|Activate|Deactivate>Epilog.py.

Examples for each of these methods for each event can be found in the files:

• ./Templates/BootstrapEpilog.sh
• ./Templates/BootstrapEpilog.cmd
• ./Templates/BootstrapEpilog.py
• ./Templates/ActivateEpilog.sh
• ./Templates/ActivateEpilog.cmd
• ./Templates/ActivateEpilog.py
• ./Templates/DeactivateEpilog.sh
• ./Templates/DeactivateEpilog.cmd
• ./Templates/DeactivateEpilog.py

The events to customize and the means by which they are customized are based on the needs of your repository and the operating systems that it supports.

Notes on Customization via Python Files

• Python files are invoked within an activated environment.
• Python files may optionally write operating-system-specific functionality to a temporary file whose name is provided as the first argument when invoking the python script. These instructions are invoked within the current terminal environment once the python script is complete.

Bootstrap Examples

The following examples all use pip to install requirements defined in a requirements.txt file.

BootstrapEpilog.sh

#!/usr/bin/env bash
pip install -r requirements.txt

BootstrapEpilog.cmd

pip install -r requirements.txt

BootstrapEpilog.py

import os
os.system("pip install -r requirements.txt")