From 6dcf0d64b4c708b4d037df0e213a5f5869f8327e Mon Sep 17 00:00:00 2001 From: nesnoj Date: Thu, 18 Jul 2024 13:34:40 +0200 Subject: [PATCH 1/3] Fix docs on user-defined output path for csv, xml, database #549 --- docs/advanced.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/advanced.md b/docs/advanced.md index 9f5589a7..90e1c9ff 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -28,6 +28,7 @@ The possible databases are: ### Project directory The directory `$HOME/.open-MaStR` is automatically created. It is used to store configuration files and save data. +You can change this default path, see [environment variables](#environment-variables). Default config files are copied to this directory which can be modified - but with caution. The project home directory is structured as follows (files and folders below `data/` just an example). @@ -87,6 +88,15 @@ The data can then be written to any sql database supported by [sqlalchemy](https For more information regarding the database see [Database settings](#database-settings). +### Environment variables + +There are some environment variables to customize open-MaStR: + +| Variable | Description | Example | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| `SQLITE_DATABASE_PATH` | Path to the SQLite file. This allows to use to use multiple instances of the MaStR database. The database instances exist in parallel and are independent of each other. | `/home/mastr-rabbit/.open-MaStR/data/sqlite/your_custom_instance_name.db` | +| `OUTPUT_PATH` | Path to user-defined output directory for CSV data, XML file and database. If not specified, output directory defaults to `$HOME/.open-MaStR/` | Linux: `/home/mastr-rabbit/open-mastr-user-defined-output-path`, Windows: `C:\\Users\\open-mastr-user-defined-output-path` | + ## Bulk download On the homepage [MaStR/Datendownload](https://www.marktstammdatenregister.de/MaStR/Datendownload) a zipped folder containing the whole From b032d851878fc6fbd7cb077aed1283cfaaa2cfca Mon Sep 17 00:00:00 2001 From: nesnoj Date: Thu, 18 Jul 2024 13:34:55 +0200 Subject: [PATCH 2/3] Update changelog --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e095147..195ac049 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,8 @@ and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/ ### Added ### Changed - Fix usercff workflow [#545](https://github.com/OpenEnergyPlatform/open-MaStR/issues/544) +- Fix docs on user-defined output path for csv, xml, database + [#549](https://github.com/OpenEnergyPlatform/open-MaStR/issues/549) ### Removed ## [v0.14.4] Release for the Journal of Open Source Software JOSS - 2024-06-07 From db69d0e60c6d0fd0401b8111676d95b4157c8102 Mon Sep 17 00:00:00 2001 From: nesnoj Date: Thu, 18 Jul 2024 13:37:39 +0200 Subject: [PATCH 3/3] Add nesnoj to contributors --- CITATION.cff | 5 +++++ pyproject.toml | 4 +++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index 12415aa3..4ecc093a 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -25,6 +25,11 @@ authors: alias: "@deniztepe" affiliation: "fortiss" orcid: " https://orcid.org/0000-0002-7605-0173" + - family-names: "Amme" + given-names: "Jonathan" + alias: "@nesnoj" + affiliation: "Reiner Lemoine Institut" + orcid: " https://orcid.org/0000-0002-8563-5261" title: "open-MaStR" type: software license: AGPL-3.0 diff --git a/pyproject.toml b/pyproject.toml index 2387333b..580de653 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,13 +25,15 @@ authors = [ {name = "Muschner Christoph"}, {name = "Kotthoff Florian"}, {name = "Tepe Deniz"}, + {name = "Amme Jonathan"}, {name = "Open Energy Family"}, ] maintainers = [ {name = "Ludwig Hülk", email = "datenzentrum@rl-institut.de"}, {name = "Florian Kotthoff"}, - {name = "Christoph Muschner", email = "datenzentrum@rl-institut.de"} + {name = "Christoph Muschner", email = "datenzentrum@rl-institut.de"}, + {name = "Jonathan Amme", email = "jonathan.amme@rl-institut.de"} ] description = "A package that provides an interface for downloading and processing the data of the Marktstammdatenregister (MaStR)" readme = "README.rst"