Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 1.72 KB

installation.rst

File metadata and controls

72 lines (45 loc) · 1.72 KB
Raw

Setup

Wetterdienst can be used by either installing it on your workstation or within a Docker container.

Native

The installation of wetterdienst can happen via PyPi or directly from GitHub. The GitHub version will always include most recent changes that may not have been released to PyPI.

PyPI

pip install wetterdienst

GitHub

pip install git+https://github.com/earthobservations/wetterdienst

There are some extras available for wetterdienst. Use them like:

pip install wetterdienst[sql]
  • ipython: Install iPython stack.
  • excel: Install openpyxl for Excel export.
  • docs: Install the Sphinx documentation generator.
  • sql: Install DuckDB for querying data using SQL.
  • duckdb: Install support for DuckDB.
  • influxdb: Install support for InfluxDB.
  • cratedb: Install support for CrateDB.
  • mysql: Install support for MySQL.
  • postgresql: Install support for PostgreSQL.

Docker

We have a Docker image available that let's you run the library dockerized. To use Wetterdienst in a Docker container, you just have to build the image from this project

docker build -t "wetterdienst" .

To run the tests in the given environment, just call

docker run -ti -v $(pwd):/app wetterdienst:latest poetry run pytest -vvvv tests

from the main directory. To work in an iPython shell, invoke

docker run -ti -v $(pwd):/app wetterdienst:latest poetry run ipython

Command line script

The wetterdienst command is also available through Docker:

docker run -ti -v $(pwd):/app wetterdienst:latest poetry run wetterdienst --help