.env.example

# =============================================================================
# Example environment file for local development and testing
# =============================================================================
#
# Copy this file to `.env` and fill in the values that apply to your setup:
#
#   cp .env.example .env
#
# `.env` is git-ignored and must never be committed. The file is picked up
# automatically by the VSCode Python extension (test explorer and debug
# configurations). On the plain command line the variables have to be exported
# by the shell, since neither the test suite nor the crawler reads `.env` on
# its own. The crawler itself accepts an explicit environment file via
# `datacrawler --env <file>` or the `DATA_CRAWLER_ENV` variable.
#
# Tests whose credentials are missing are skipped or fail with an explanatory
# message - only the Redis connection is mandatory for a large part of the
# suite.

# -----------------------------------------------------------------------------
# Redis (required by most tests, test artefacts are written to the given DB)
# -----------------------------------------------------------------------------
DATA_CRAWLER_REDIS_HOST=localhost
DATA_CRAWLER_REDIS_PORT=6379
DATA_CRAWLER_REDIS_DB=0
# Password of a secured Redis instance, referenced by some example configurations
#REDIS_PASSWORD=
#REDIS_HOST=

# -----------------------------------------------------------------------------
# MQTT broker (required by the MQTT sink and source tests, `mqtt` extra)
# The tests are skipped if the host or the respective port is not set.
# -----------------------------------------------------------------------------
DATA_CRAWLER_MQTT_HOST=localhost
DATA_CRAWLER_MQTT_PORT=1883
DATA_CRAWLER_MQTT_SSL_PORT=8883

# -----------------------------------------------------------------------------
# InfluxDB 2 (required by the InfluxDB source tests)
# All four variables must be set, otherwise the tests are skipped. The test
# suite creates and removes its own bucket via the given user credentials.
# -----------------------------------------------------------------------------
DATA_CRAWLER_INFLUX_URL=http://localhost:8086
DATA_CRAWLER_INFLUX_ORG=ait
DATA_CRAWLER_INFLUX_USER=admin
DATA_CRAWLER_INFLUX_PASSWORD=

# -----------------------------------------------------------------------------
# Public APIs
# -----------------------------------------------------------------------------
# Contact details that are sent to APIs which require them (e.g. yr.no, geosphere.at)
DATA_CRAWLER_CONTACT=your.name@example.org

# API keys of the commercial data sources. The corresponding tests are skipped
# if the key is missing.
#DATA_CRAWLER_KNMI_API_KEY=
#DATA_CRAWLER_WEATHERBIT_API_KEY=
#DATA_CRAWLER_ENTSO_E_API_KEY=

# -----------------------------------------------------------------------------
# Generic credentials used by the example/test configurations
# -----------------------------------------------------------------------------
API_USER=database-host
API_KEY=not-a-real-pwd

# -----------------------------------------------------------------------------
# Runtime settings of the crawler itself (not needed for the test suite)
# -----------------------------------------------------------------------------
#DATA_CRAWLER_CONFIG=/etc/data_crawler/config.yml
#DATA_CRAWLER_ENV=/etc/data_crawler/default.env
#DATA_CRAWLER_DRY_RUN_WRITES=false
# Default location and station metadata of some example configurations
#DATA_CRAWLER_LAT=48.2
#DATA_CRAWLER_LON=16.37
#DATA_CRAWLER_STATION_NAME=