Skip to main content

Pipeline Setup

Before running or developing the pipeline, we need to ensure your IDE can properly find and execute all code modules. This setup ensures:

  • Correct module imports
  • Proper test execution
  • Debugging capabilities

1. Prerequisite​

Follow the Setup Virtual Environment guide to create a virtual environment.

2. Installing Requirements​

After setting up your virtual environment, install the necessary packages:

  1. Activate your virtual environment
  2. Install requirements
make req-install

3. IDE Configuration​

PyCharm Setup​

project_root/
├── src/           # Source code directory
└── tests/         # Test files directory
  1. Configure source roots:
  • Right-click src → "Mark Directory as" → "Sources Root"
  • This folder will turn blue, indicating PyCharm recognizes it as source code
  1. Configure test roots:
  • Right-click tests → "Mark Directory as" → "Test Sources Root"
  • This folder will turn green, indicating PyCharm recognizes it as test code

VS Code Setup​

  1. Create a .env file in your project root:
PYTHONPATH=src
  1. Update settings.json:
"python.envFile": "${workspaceFolder}/.env"

3. Test​

To verify that your setup was completed successfully

  1. Run the tests from the tests directory directly using your IDE. or
  2. Run make test command in your terminal.