axem-dem 0.7.1

Manager for Containerized Development Environments

Development Environment Manager
for
Embedded Development

Manage your isolated Development Environments with ease

:star2: Join our Community on Discord :star2:

Overview

Documentation • Tutorial • Contribution guide • Support

DEM is a command-line tool that provides an easy, reproducible, and scalable way to set up multi-container-based Development Environments for software development.

DEM can be used locally, but it is in alpha state, so expect major changes in the future!

Contributors and early adopters are welcome!

:fallen_leaf: Hacktoberfest 2024

DEM is participating again in Hacktoberfest! We are looking for contributors to help us improve the tool. If you are interested, here is how to get started:

1. Read the Hacktoberfest guide.
2. Check the documentation and try out DEM to get familiar with the tool.
3. Look for issues with the hacktoberfest label in the issue tracker.
4. Read the Code of Conduct and the Contribution Guide.
5. Join our Discord server to get help and discuss the issues. There is a dedicated channel called #hacktoberfest for this purpose.

The Concept in a Nutshell

A set of software tools used for a specific development project is called a Development Environment. These tools for example can be the build system, debugger, test framework, etc...

The idea is to pack the tools separately into container images, which are then can be stored in registries.

How is DEM different from other container-based development environments?
Instead of putting all the tools into a single image and then the user must enter the container using an interactive shell, DEM creates a separate one for each tool. This means the user can work on their host system, with their usual setup, but the Development Environment specific tools are isolated in containers.

Each Development Environment has a descriptor. A descriptor, like a blueprint, indicates which tools are required in the project, and the place their container images are stored.

The descriptors can be stored in the Development Environment Catalogs. The users can browse these catalogs, and download a copy of the Development Environment descriptor to their local catalog.

The users can install a Development Environments from their local catalog or freely create their own based on the tools available in the registries or on their local system.

Key features

• Create scalable, reliable, and reproducible containerized Development Environments
• Install preconfigured Development Environments from catalogs
• Ensure that everyone in the team works with the same toolset
• Share Development Environments outside of your organization

Prerequisites

To be able to use the DEM on your PC, you need to have the following software installed:

• Python 3.10+
• Docker Engine 24.0+

:information_source: Currently only the Linux operating system and the Docker Engine are supported.

Installation

You can download the installer script from the root of the repository:

curl -O https://raw.githubusercontent.com/axem-solutions/dem/main/install-dem.sh

If you are happy with the content of the script, you can execute it:

bash install-dem.sh

Alternative installation

If all the prerequisites are fulfilled, the DEM can be installed from the PyPI repository:

pip install axem-dem

:information_source: The package name is axem-dem, but the command is dem.

Enable autocompletion

After installation, you can enable the autocompletion for bash and zsh shells

dem --install-completion

If the command didn't work, supply your shell type as input parameter (bash or zsh) Note for zsh users: compinit must be called from your .zshrc.

Quick start

We got you covered in all scenarios:

I'd like to start with a template...

By default, DEM comes with a few templates available from the axem catalog. You can list them with:

dem list --cat axem

You can clone the selected template with:

dem clone DEV_ENV_NAME

I'd like to work on a project already configured with DEM...

In this case you only need to enter the project's root directory and initialize the Dev Env with:

dem init

I'd like to use a Dev Env someone shared with me...

You can import a Dev Env descriptor JSON with:

dem load PATH_TO_DEV_ENV

where PATH_TO_DEV_ENV is the path to the JSON file.

I'd like to create my own Dev Env from scratch...

Create a brand new Dev Env with the following command:

dem create DEV_ENV_NAME

Now you have the Dev Env descriptor in your local catalog, but you might want to set a few things:

• Add/remove tools.
• Change the tool image for a given tool.

You can edit it with:

dem modify DEV_ENV_NAME

Finally, if you are ready to use the Development Environment, you can install it with:

dem install DEV_ENV_NAME

For more detailed instructions please refer to the Documentation