Merge pull request #475 from OpenEnergyPlatform/release-v0.14.0

Release v0.14.0 - Shiny New Documentation Page

Author: FlorianK13

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.13.2
+current_version = 0.14.0
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)((?P<release>(a|na))+(?P<build>\d+))?
 serialize = 
 	{major}.{minor}.{patch}{release}{build}

.github/workflows/ci-develop.yml

@@ -2,9 +2,6 @@ name: CI
 
 on:
   workflow_dispatch:
-  push:
-    branches:
-      - develop
   pull_request:
     branches:
       - develop

.github/workflows/ci-production.yml

@@ -2,9 +2,6 @@ name: CI
 
 on:
   workflow_dispatch:
-  push:
-    branches:
-      - production
   pull_request:
     branches:
       - production
@@ -34,7 +31,7 @@ jobs:
     - name: create package
       run: python setup.py sdist
     - name: import open-mastr
-      run: python -m pip install ./dist/open_mastr-0.13.2.tar.gz
+      run: python -m pip install ./dist/open_mastr-0.14.0.tar.gz
     - name: Create credentials file
       env:
         MASTR_TOKEN: ${{ secrets.MASTR_TOKEN }}

.github/workflows/pypi-publish.yml

@@ -1,7 +1,6 @@
-name: Build 📦 and release on pypi
+name: ⚠️ Build production package and release on pypi
 
 on:
-  workflow_dispatch:
   release:
     types: [published]
 

.gitignore

@@ -102,7 +102,6 @@ ENV/
 
 # PyCharm
 .idea
-data/
 config.ini
 postprocessing/plots/
 

.pre-commit-config.yaml

@@ -3,4 +3,4 @@ repos:
     rev: 22.6.0
     hooks:
       - id: black
-        language_version: python3.10
+        language_version: python3.10

.readthedocs.yml

@@ -1,15 +1,15 @@
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
 version: 2
+
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
-    python: "3.10"
-formats:
-  - htmlzip
-sphinx:
-  configuration: docs/conf.py
+    python: "3.11"
+
+mkdocs:
+  configuration: mkdocs.yml
+
 python:
   install:
-    - requirements: docs/requirements.txt
-    - method: pip
-      path: .
-  system_packages: true
+  - requirements: docs/requirements.txt

CHANGELOG.md

@@ -6,14 +6,30 @@ 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).
 
+## [v0.14.0] Shiny New Documentation Page - 2023-11-22
+### Added
+- User-defined output path for csv, xml, database [#402](https://github.com/OpenEnergyPlatform/open-MaStR/pull/402)
+- Add date=existing parameter to Mastr.download [#452](https://github.com/OpenEnergyPlatform/open-MaStR/pull/452)
+- Update documentation and release it on mkdocs [#460](https://github.com/OpenEnergyPlatform/open-MaStR/pull/460)
+- Replace values in ArtDerFlaecheIds with their entries from katalogwerte [#464](https://github.com/OpenEnergyPlatform/open-MaStR/pull/464)
+- Add a Mastr.translate method for english translation [##471](https://github.com/OpenEnergyPlatform/open-MaStR/pull/471)
+
+### Changed
+- Using sphinx version <7 to build documentation [#454](https://github.com/OpenEnergyPlatform/open-MaStR/pull/454)
+- Get missing column names in xml download in a robust way [#470](https://github.com/OpenEnergyPlatform/open-MaStR/pull/470)
+- Adapt column names to the API web service update [#472](https://github.com/OpenEnergyPlatform/open-MaStR/pull/472)
+
+### Removed
+- Delete `on push` for github workflow [#445](https://github.com/OpenEnergyPlatform/open-MaStR/pull/445)
+
 ## [v0.13.2] Hotfix - 2023-08-07
 ### Changed
 - Changed the name of the bulk tables for technology=gsgk [#456](https://github.com/OpenEnergyPlatform/open-MaStR/pull/456)
 
 ## [v0.13.1] Hotfix - 2023-04-11
-
 ### Added
 - Add new table and new columns to the data model [#440](https://github.com/OpenEnergyPlatform/open-MaStR/pull/440)
+
 ## [v0.13.0] Maintenance release - 2023-02-16
 ### Added
 - Add a `workflow_dispatch` to run CI pipelines from a button click [#389](https://github.com/OpenEnergyPlatform/open-MaStR/pull/389)

CITATION.cff

@@ -28,7 +28,7 @@ authors:
 title: "open-MaStR"
 type: software
 license: AGPL-3.0
-version: 0.13.2
+version: 0.14.0
 doi: 
-date-released: 2023-08-07
+date-released: 2023-11-22
 url: "https://github.com/OpenEnergyPlatform/open-MaStR/"

README.rst

@@ -20,11 +20,13 @@ open-mastr
    * - Tests
      - |badge_ci|
    * - Publication
-     - |badge_pypi| |badge_zenodo|
+     - |badge_pypi|
+   * - Data Publication
+     - |badge_zenodo|
    * - Development
      - |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
    * - Community
-     - |badge_contributing| |badge_contributors| |badge_repo_counts| |PyPI download month|
+     - |badge_contributing| |badge_contributors| |badge_repo_counts| |PyPI download month| |Total PyPI downloads|
 
 
 .. contents::
@@ -53,7 +55,7 @@ The MaStR data can be
 Documentation
 =============
 
-| The documentation is in `sphinx <http://www.sphinx-doc.org/en/stable/>`_ reStructuredText format in the ``doc`` sub-folder of the repository.
+| The documentation is in `Material for Mkdocs <https://squidfunk.github.io/mkdocs-material/>`_ markdown format in the ``doc`` sub-folder of the repository.
 | Find the `documentation <https://open-mastr.readthedocs.io/en/latest/>`_ hosted on ReadTheDocs.
 
 | The original API documentation can be found on the `Webhilfe des Marktstammdatenregisters <https://www.marktstammdatenregister.de/MaStRHilfe/subpages/webdienst.html>`_.
@@ -97,7 +99,7 @@ Install the package with
 
 .. code-block:: python
 
-    python setup.py install
+    pip install "open_mastr[dev]"
 
 
 Examples of Usage
@@ -152,7 +154,7 @@ Data
     :alt: PyPI
 
 .. |badge_zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.6807426.svg
-    :target: https://doi.org/10.5281/zenodo.6807426
+    :target: https://doi.org/10.5281/zenodo.6807425
     :alt: zenodo
 
 .. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/OpenEnergyPlatform/open-MaStR
@@ -173,8 +175,13 @@ Data
 .. |badge_contributors| image:: https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square
     :alt: contributors
 
-.. |badge_repo_counts| image:: http://hits.dwyl.com/OpenEnergyPlatform/open-MaStR.svg
+.. |badge_repo_counts| image:: https://hits.dwyl.com/OpenEnergyPlatform/open-MaStR.svg
     :alt: counter
 
 .. |PyPI download month| image:: https://img.shields.io/pypi/dm/open-mastr?label=PyPi%20Downloads
-    :target: https://pypi.org/project/open-mastr/
+    :target: https://pypistats.org/packages/open-mastr
+
+.. |Total PyPI downloads| image:: https://static.pepy.tech/badge/open-mastr
+    :target: https://pepy.tech/project/open-mastr
+
+