Skip to content

Commit 6f14638

Browse files
authored
Merge pull request #475 from OpenEnergyPlatform/release-v0.14.0
Release v0.14.0 - Shiny New Documentation Page
2 parents 7b155a9 + 8276211 commit 6f14638

File tree

80 files changed

+3822
-1754
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+3822
-1754
lines changed

.bumpversion.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[bumpversion]
2-
current_version = 0.13.2
2+
current_version = 0.14.0
33
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)((?P<release>(a|na))+(?P<build>\d+))?
44
serialize =
55
{major}.{minor}.{patch}{release}{build}

.github/workflows/ci-develop.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@ name: CI
22

33
on:
44
workflow_dispatch:
5-
push:
6-
branches:
7-
- develop
85
pull_request:
96
branches:
107
- develop

.github/workflows/ci-production.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@ name: CI
22

33
on:
44
workflow_dispatch:
5-
push:
6-
branches:
7-
- production
85
pull_request:
96
branches:
107
- production
@@ -34,7 +31,7 @@ jobs:
3431
- name: create package
3532
run: python setup.py sdist
3633
- name: import open-mastr
37-
run: python -m pip install ./dist/open_mastr-0.13.2.tar.gz
34+
run: python -m pip install ./dist/open_mastr-0.14.0.tar.gz
3835
- name: Create credentials file
3936
env:
4037
MASTR_TOKEN: ${{ secrets.MASTR_TOKEN }}

.github/workflows/pypi-publish.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
name: Build 📦 and release on pypi
1+
name: ⚠️ Build production package and release on pypi
22

33
on:
4-
workflow_dispatch:
54
release:
65
types: [published]
76

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,6 @@ ENV/
102102

103103
# PyCharm
104104
.idea
105-
data/
106105
config.ini
107106
postprocessing/plots/
108107

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ repos:
33
rev: 22.6.0
44
hooks:
55
- id: black
6-
language_version: python3.10
6+
language_version: python3.10

.readthedocs.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
2+
13
version: 2
4+
25
build:
3-
os: ubuntu-20.04
6+
os: ubuntu-22.04
47
tools:
5-
python: "3.10"
6-
formats:
7-
- htmlzip
8-
sphinx:
9-
configuration: docs/conf.py
8+
python: "3.11"
9+
10+
mkdocs:
11+
configuration: mkdocs.yml
12+
1013
python:
1114
install:
12-
- requirements: docs/requirements.txt
13-
- method: pip
14-
path: .
15-
system_packages: true
15+
- requirements: docs/requirements.txt

CHANGELOG.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,30 @@ For each version important additions, changes and removals are listed here.
66
The format is inspired from [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
77
and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
88

9+
## [v0.14.0] Shiny New Documentation Page - 2023-11-22
10+
### Added
11+
- User-defined output path for csv, xml, database [#402](https://github.com/OpenEnergyPlatform/open-MaStR/pull/402)
12+
- Add date=existing parameter to Mastr.download [#452](https://github.com/OpenEnergyPlatform/open-MaStR/pull/452)
13+
- Update documentation and release it on mkdocs [#460](https://github.com/OpenEnergyPlatform/open-MaStR/pull/460)
14+
- Replace values in ArtDerFlaecheIds with their entries from katalogwerte [#464](https://github.com/OpenEnergyPlatform/open-MaStR/pull/464)
15+
- Add a Mastr.translate method for english translation [##471](https://github.com/OpenEnergyPlatform/open-MaStR/pull/471)
16+
17+
### Changed
18+
- Using sphinx version <7 to build documentation [#454](https://github.com/OpenEnergyPlatform/open-MaStR/pull/454)
19+
- Get missing column names in xml download in a robust way [#470](https://github.com/OpenEnergyPlatform/open-MaStR/pull/470)
20+
- Adapt column names to the API web service update [#472](https://github.com/OpenEnergyPlatform/open-MaStR/pull/472)
21+
22+
### Removed
23+
- Delete `on push` for github workflow [#445](https://github.com/OpenEnergyPlatform/open-MaStR/pull/445)
24+
925
## [v0.13.2] Hotfix - 2023-08-07
1026
### Changed
1127
- Changed the name of the bulk tables for technology=gsgk [#456](https://github.com/OpenEnergyPlatform/open-MaStR/pull/456)
1228

1329
## [v0.13.1] Hotfix - 2023-04-11
14-
1530
### Added
1631
- Add new table and new columns to the data model [#440](https://github.com/OpenEnergyPlatform/open-MaStR/pull/440)
32+
1733
## [v0.13.0] Maintenance release - 2023-02-16
1834
### Added
1935
- Add a `workflow_dispatch` to run CI pipelines from a button click [#389](https://github.com/OpenEnergyPlatform/open-MaStR/pull/389)

CITATION.cff

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ authors:
2828
title: "open-MaStR"
2929
type: software
3030
license: AGPL-3.0
31-
version: 0.13.2
31+
version: 0.14.0
3232
doi:
33-
date-released: 2023-08-07
33+
date-released: 2023-11-22
3434
url: "https://github.com/OpenEnergyPlatform/open-MaStR/"

README.rst

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,13 @@ open-mastr
2020
* - Tests
2121
- |badge_ci|
2222
* - Publication
23-
- |badge_pypi| |badge_zenodo|
23+
- |badge_pypi|
24+
* - Data Publication
25+
- |badge_zenodo|
2426
* - Development
2527
- |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
2628
* - Community
27-
- |badge_contributing| |badge_contributors| |badge_repo_counts| |PyPI download month|
29+
- |badge_contributing| |badge_contributors| |badge_repo_counts| |PyPI download month| |Total PyPI downloads|
2830

2931

3032
.. contents::
@@ -53,7 +55,7 @@ The MaStR data can be
5355
Documentation
5456
=============
5557

56-
| The documentation is in `sphinx <http://www.sphinx-doc.org/en/stable/>`_ reStructuredText format in the ``doc`` sub-folder of the repository.
58+
| The documentation is in `Material for Mkdocs <https://squidfunk.github.io/mkdocs-material/>`_ markdown format in the ``doc`` sub-folder of the repository.
5759
| Find the `documentation <https://open-mastr.readthedocs.io/en/latest/>`_ hosted on ReadTheDocs.
5860
5961
| 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
9799

98100
.. code-block:: python
99101
100-
python setup.py install
102+
pip install "open_mastr[dev]"
101103
102104
103105
Examples of Usage
@@ -152,7 +154,7 @@ Data
152154
:alt: PyPI
153155

154156
.. |badge_zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.6807426.svg
155-
:target: https://doi.org/10.5281/zenodo.6807426
157+
:target: https://doi.org/10.5281/zenodo.6807425
156158
:alt: zenodo
157159

158160
.. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/OpenEnergyPlatform/open-MaStR
@@ -173,8 +175,13 @@ Data
173175
.. |badge_contributors| image:: https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square
174176
:alt: contributors
175177

176-
.. |badge_repo_counts| image:: http://hits.dwyl.com/OpenEnergyPlatform/open-MaStR.svg
178+
.. |badge_repo_counts| image:: https://hits.dwyl.com/OpenEnergyPlatform/open-MaStR.svg
177179
:alt: counter
178180

179181
.. |PyPI download month| image:: https://img.shields.io/pypi/dm/open-mastr?label=PyPi%20Downloads
180-
:target: https://pypi.org/project/open-mastr/
182+
:target: https://pypistats.org/packages/open-mastr
183+
184+
.. |Total PyPI downloads| image:: https://static.pepy.tech/badge/open-mastr
185+
:target: https://pepy.tech/project/open-mastr
186+
187+

0 commit comments

Comments
 (0)