Getting Started

IDE Compatibility

VM-Lab development works with popular Python IDEs:

• Visual Studio Code
• PyCharm

Project Setup

VM-Lab can be set up using two different approaches, depending on your preferences and environment.

Note

If you're just exploring or want a quick start, go with the Docker setup.

If you're contributing to the project internals, consider the local development setup.

Local Development Setup

A traditional method that gives you full control and insight into the environment. See how to achieve this here.

• More complex to configure.
• Requires manual installation of dependencies.
• Ideal for debugging and contributing to the core codebase.

Docker-Based Setup

A faster, containerized method ideal for quick starts and consistent environments. See how to achieve this here.

• Easy to set up.
• Mostly (see the page for more details) pre-configured environment using Docker Compose.
• Great for testing and deployment across systems.