Installation¶
All commands are intended to be run from the repository root in an Ubuntu Bash shell.
Before running installer scripts from a fresh clone, ensure they are executable:
chmod +x scripts/*.sh
The combined base installer runs the standard toolchain installers in sequence:
./scripts/run_install_common_base.sh
It installs or updates Python 3.12, Micromamba, the PostgreSQL client, Docker Engine, and act. The individual installers can also be run separately as described below.
Python¶
The project requires Python 3.12.
./scripts/run_install_python.sh
Micromamba¶
Micromamba is used to create the project environments from config/environment.yml and config/environment_dev.yml.
./scripts/run_install_micromamba.sh
After installation, open a new shell or initialize Micromamba in the current shell:
eval "$(micromamba shell hook --shell=bash)"
Docker¶
On native Ubuntu, install Docker Engine with:
./scripts/run_install_docker.sh
On WSL 2, Docker Desktop for Windows can be used instead when WSL integration is enabled.
PostgreSQL Client¶
Install the PostgreSQL client tools with:
./scripts/run_install_postgresql_client.sh
AWS CLI¶
Install AWS CLI v2 with:
./scripts/run_install_aws_cli.sh
act¶
Install the local GitHub Actions runner with:
./scripts/run_install_act.sh
DBeaver (optional)¶
DBeaver Community can be installed with:
./scripts/run_install_dbeaver.sh
Python Libraries¶
The project dependencies are managed through Micromamba environment files and the do.sh script.
Development environment: run
./do.sh conda-dev.Production environment: run
./do.sh conda-prod.
After creating the environment, activate it before running project targets:
micromamba activate iotemplatelib