Setting Up the Development Environment

This guide provides instructions for setting up a development environment for Aerleon.

Prerequisites

Before starting, ensure you have the following installed: - Python 3.10+ - Poetry 2.2+

Steps

1. Clone the Repository

   git clone https://github.com/aerleon/aerleon.git
   cd aerleon
   

2. Install Dependencies Use Poetry to install all required dependencies.

   poetry install
   

3. Run Tests Verify the setup by running the test suite.

   poetry run pytest
   

4. Activate Pre-Commit Hooks Set up pre-commit hooks to ensure code quality.

   poetry run pre-commit install
   

5. Start Development You are now ready to start contributing to Aerleon. Make sure to follow the contributing guidelines.

Troubleshooting

• If you encounter issues with Poetry, refer to the Poetry documentation.

Using the Devcontainer

Aerleon provides a development container to simplify the setup process. Follow these steps to use it:

1. Open the Project in VS Code Ensure you have the Remote - Containers extension installed.

2. Reopen in Container

3. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).

4. Select Remote-Containers: Reopen in Container.

5. Wait for Setup VS Code will build the container and install all dependencies automatically. This may take a few minutes.

6. Start Developing Once the container is ready, you can start developing immediately. All tools and dependencies are pre-installed.