.env

# Environment variables go here, and can be read in by Python using the `python-dotenv`
# package, and `os.getenv`:
#
#   ------------------------------------------------------------------------------------
#   from dotenv import load_dotenv
#   import os
#
#   # Load the environment variables from the `.env` file, overriding any system
#   # environment variables
#   load_dotenv(override=True)
#
#   # Load secrets from the `.secrets` file, overriding any system environment variables
#   load_dotenv(".secrets", override=True)
#
#   # Example variable
#   EXAMPLE_VARIABLE = os.getenv("EXAMPLE_VARIABLE")
#   ------------------------------------------------------------------------------------
#
# For folder/file path environment variables, use relative paths.
#
# DO NOT STORE SECRETS HERE - this file is version-controlled! You should store secrets
# in the untracked `.secrets` file.


# Add environment variables for the `data` directories
DIR_DATA=./data
DIR_DATA_EXTERNAL=./data/external
DIR_DATA_RAW=./data/raw
DIR_DATA_INTERIM=./data/interim
DIR_DATA_PROCESSED=./data/processed

# Add environment variables for the `docs` directory
DIR_DOCS=./docs

# Add environment variables for the `notebooks` directory
DIR_NOTEBOOKS=./notebooks

# Add environment variables for the `outputs` directory
DIR_OUTPUTS=./outputs

# Add environment variables for the `src` directories
DIR_SRC=./src
DIR_SRC_MAKE_DATA=./src/make_data
DIR_SRC_MAKE_FEATURES=./src/make_features
DIR_SRC_MAKE_MODELS=./src/make_models
DIR_SRC_MAKE_VISUALISATIONS=./src/make_visualisations
DIR_SRC_UTILS=./src/utils

# Add environment variables for the `tests` directory
DIR_TESTS=./tests