Skip to main content

Setting Up a Dev Environment

Initial Setup

Familiarize yourself with contributing to these documents prior to modifying/testing code. Updating documentation is a shared responsibility.
git clone https://github.com/nasa/cumulus-orca
Install Python 3.9.X and restart if needed. Make sure Python is added to your PATH.
Install the AWS client. View the official documentation if needed.
```
pip3 install awscli
```
Install and Configure git-secrets

Per-Lambda Setup

Lambdas should be built and tested within individual Virtual Environments.

Navigate to the task's folder within 'culumus-orca\tasks[task name]'.
Create and activate a new Python Virtual Environment.
1. Windows Command Line:
  Create:
```
python -m venv venv
```
  Activate:
```
venv\Scripts\activate
```
  Deactivate:
```
venv\Scripts\deactivate.bat
```
2. Linux/Cmder:
  Create:
```
python -m venv venv
```
  Activate:
```
source venv/bin/activate
```
  Deactivate:
```
deactivate
```
With the VEnv activated, install requirements.
```
pip install boto3
pip install -r requirements.txt
```
tip
If you receive 403 errors while attempting to run pip install commands, try adding --trusted-host pypi.org --trusted-host files.pythonhosted.org to the end of the command. For example: pip install -r requirements.txt --trusted-host pypi.org --trusted-host files.pythonhosted.org

Install additional development requirements.

pip install coverage
pip install pylint
pip install -r requirements-dev.txt

tip

See Local Debugging for running local code against AWS.

Initial Setup
Per-Lambda Setup