Merge pull request #112 from OpenEnergyPlatform/release-v1.0.0

Release v1.0.0

Author: jh-RLI

.bumpversion.cfg

@@ -0,0 +1,38 @@
+[tool.bumpversion]
+current_version = "1.0.0"
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
+serialize = ["{major}.{minor}.{patch}"]
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+ignore_missing_version = false
+ignore_missing_files = false
+tag = true
+sign_tags = false
+tag_name = "v{new_version}"
+tag_message = "v{new_version}"
+allow_dirty = false
+commit = true
+message = "Bump version: {current_version} → {new_version}"
+commit_args = ""
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+
+[[tool.bumpversion.files]]
+filename = "CHANGELOG.md"
+search = "[Unreleased]"
+replace = "[Unreleased] - {now:%Y-%m-%d}"
+
+[[tool.bumpversion.files]]
+filename = "CHANGELOG.md"
+search = "Unreleased"
+
+[[tool.bumpversion.files]]
+filename = "README.rst"
+
+[[tool.bumpversion.files]]
+filename = "docs/conf.py"
+
+[[tool.bumpversion.files]]
+filename = "omi/__init__.py"

.bumpversion.toml

@@ -0,0 +1,31 @@
+---
+name: Bug Issue
+about: For bugs and errors 
+title: Your title should make sense if said after "The issue is <your issue title>"
+labels: "bug"
+assignees: ''
+
+---
+
+## Description of the issue
+
+Describe the problem in as much detail as possible.
+Focus on the expected and current behavior. 
+If necessary, create a screenshot and insert below.
+
+## Steps to Reproduce
+1.
+2.
+3.
+
+## Ideas of solution
+
+Describe possible ideas for solution and evaluate advantages and disadvantages.
+
+## Context and Environment
+* Version used: 
+* Operating system: 
+* Environment setup and (python) version: 
+
+## Workflow checklist
+- [ ] I am aware of the workflow in [CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/develop/CONTRIBUTING.md)

.cookiecutterrc

@@ -0,0 +1,19 @@
+---
+name: Feature Issue
+about: For new ideas, developments and features
+title: Your title should make sense if said after "The issue is <your issue title>"
+labels: "enhancement"
+assignees: ''
+
+---
+
+## Description of the issue
+
+Describe the problem in as much detail as possible. 
+
+## Ideas of solution
+
+Describe possible ideas for solution and evaluate advantages and disadvantages.
+
+## Workflow checklist
+- [ ] I am aware of the workflow in [CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/develop/CONTRIBUTING.md)

.github/ISSUE_TEMPLATE/issue_template_bug.md

@@ -0,0 +1,29 @@
+## Summary of the discussion
+
+Describe the findings of the discussion in the issue or meeting.
+
+## Type of change (CHANGELOG.md)
+
+### Added
+- Add a new class [(#)](https://github.com/rl-institut/super-repo/pull/)
+
+### Updated
+- Update a definition [(#)](https://github.com/rl-institut/super-repo/pull/)
+
+### Removed
+- Remove a broken link [(#)](https://github.com/rl-institut/super-repo/pull/)
+
+
+## Workflow checklist
+
+### Automation
+Closes #
+
+### PR-Assignee
+- [ ] 🐙 Follow the workflow in [CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/develop/CONTRIBUTING.md)
+- [ ] 📝 Update the [CHANGELOG.md](https://github.com/rl-institut/super-repo/blob/develop/CHANGELOG.md)
+- [ ] 📙 Update the documentation
+
+### Reviewer
+- [ ] 🐙 Follow the [Reviewer Guidelines](https://github.com/rl-institut/super-repo/blob/develop/CONTRIBUTING.md#40-let-someone-else-review-your-pr)
+- [ ] 🐙 Provided feedback and show sufficient appreciation for the work done

.github/ISSUE_TEMPLATE/issue_template_feature.md

@@ -5,7 +5,7 @@ on:
   push:
     branches:
       - master
-      - develop
+      - dev
   pull_request:
 
 jobs:
@@ -26,4 +26,4 @@ jobs:
         run: pip install tox
       - name: Run tox
         # Run tox using the version of Python in `PATH`
-        run: tox -v
+        run: tox -v

.github/pull_request_template.md

@@ -0,0 +1,35 @@
+name: CI
+
+# Enable Buildkit and let compose use it to speed up image building
+env:
+  DOCKER_BUILDKIT: 1
+  COMPOSE_DOCKER_CLI_BUILD: 1
+
+on:
+  pull_request:
+    branches: [ "master", "dev" ]
+    paths-ignore: [ "docs/**" ]
+
+  push:
+    branches: [ "master", "dev" ]
+    paths-ignore: [ "docs/**" ]
+
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  linter:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout Code Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Run pre-commit
+        uses: pre-commit/action@v3.0.1

.github/workflows/automated-testing.yml

@@ -80,4 +80,6 @@ docs/_build
 
 
 # manual testing scripts
-/local_test
+/local_test
+/script
+/.venv/

.github/workflows/linter.yml

@@ -1,12 +1,36 @@
+exclude: 'docs|node_modules|vendors|migrations|.git|.tox'
+default_stages: [commit]
+fail_fast: true
+
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-json
+        exclude: tests/test_data/validation/invalid_metadata/*
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-added-large-files
+
+  - repo: https://github.com/pre-commit/mirrors-jshint
+    rev: v2.13.6
+    hooks:
+      - id: jshint
+
   - repo: https://github.com/psf/black
-    rev: stable
+    rev: 23.3.0
     hooks:
       - id: black
-        language_version: python3
 
-  - repo: https://github.com/pre-commit/mirrors-isort
-    rev: master
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # Ruff version.
+    rev: 'v0.0.277'
+    hooks:
+      - id: ruff
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.0.0
     hooks:
-      - id: isort
-        language_version: python3
+      - id: flake8
+        args: [ "--config=setup.cfg" ]
+        additional_dependencies: [ flake8-isort ]