Merge pull request #21 from OpenEnergyPlatform/feature-16-delete-dock…

…er-compose-standalone-dependency

Feature 16 delete docker compose standalone dependency

.env.template

@@ -12,7 +12,7 @@ export DAGSTER_HOME = ~/.dagster/dagster_home
 export DBT_PROFILE_FOLDER = dev
 export IS_DEVELOP_MODE = True
 
-# Production - only relevant if dagster is run via the 'docker-compose --env-file .env up'
+# Production - only relevant if dagster is run via the 'docker compose --env-file .env up'
 export DAGSTER_WEBSERVER_PORT = 3000
 export GEOSERVER_PORT = 8002
 export DATA_WAREHOUSE_POSTGRES_DBNAME = energy_database

CHANGELOG.md

@@ -6,6 +6,12 @@ For each version important additions, changes and removals are listed here.
 The format is inspired from [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [vX.X.X]
+### Added
+### Changed
+### Removed
+- Remove dependency of the `docker-compose` standalone [#21](https://github.com/OpenEnergyPlatform/open-dapro/pull/21)
+
 
 ## [v0.1.0] Initial Release - 2023-12-01
 ### Added

README.md

@@ -7,10 +7,16 @@ open-dapro is a collection of automated data pipelines for the German energy sys
 
 ## Installation
 
-Make sure you have [docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/) installed. Clone the repository, enter it, and run
+Make sure you have [docker](https://www.docker.com/) installed. Clone the repository, enter it, and run
 ```bash
-docker-compose up
+docker compose up
 ```
+
+In case you want to change default variables, rename the `.env.template` file to `.env` and change the defined variables as you wish. Afterwards, run 
+```bash
+docker compose --env-file .env up
+```
+
 If everything worked, the GeoServer should be available at [http://127.0.0.1:8002](http://127.0.0.1:8002) and the Dagster UI at [http://127.0.0.1:3000](http://127.0.0.1:3000)
 
 To install the project in a developer setup check the [Setup for Developers](https://openenergyplatform.github.io/open-dapro/development/) on the documentation page.

development/initialize.py

@@ -23,7 +23,7 @@ def get_engine() -> sqlalchemy.engine.Engine:
 
 
 def setup_docker() -> None:
-    """Initialize a PostgreSQL database with docker-compose"""
+    """Initialize a PostgreSQL database with docker compose"""
     conf_file_path = os.path.abspath(os.path.dirname(__file__))
     subprocess.run(
         ["docker", "compose", "up", "-d"],

docs/development.md

@@ -9,10 +9,10 @@
     pip install -e ".[dev]"
     ```
 
-1. Next, make sure you have [docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/install/standalone/) installed. You can check this by running:
+1. Next, make sure you have [docker](https://www.docker.com/) installed. You can check this by running:
 
     ```bash
-    docker-compose --version
+    docker --version
     ```
 
 

docs/index.md

@@ -9,12 +9,11 @@
 
 ## Installation
 1. Clone the repository [git.fortiss.org/ASCI-public/energy-dagster](https://git.fortiss.org/ASCI-public/energy-dagster) and open it in a terminal.
-1. Make sure you have [docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/install/standalone/) installed by running 
+1. Make sure you have [docker](https://www.docker.com/) installed by running 
 ```bash
 docker --version
-docker-compose --version
 ```
-1. Run `docker-compose up` and go to [localhost:3000](localhost:3000){:target="_blank"} to see the dagster UI. A documentation of the dagster UI can be found [here](https://docs.dagster.io/concepts/webserver/ui){:target="_blank"}.
+1. Run `docker compose up` and go to [localhost:3000](localhost:3000){:target="_blank"} to see the dagster UI. A documentation of the dagster UI can be found [here](https://docs.dagster.io/concepts/webserver/ui){:target="_blank"}.
 1. Start exploring the data pipelines :tada:
 
 For an alternative setup you can also follow the instructions in the [Setup for development](development.md).