Merge branch 'main' into feature/mx-1569-date-validation

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/robert-koch-institut/mex-template",
-  "commit": "12165319453990fdbe02bce39a3236337e298bc0",
+  "commit": "a3eb74737274b4c114a85b5a816ff0f11eac4f7e",
   "checkout": null,
   "context": {
     "cookiecutter": {

.github/dependabot.yml

@@ -3,8 +3,6 @@ updates:
   - package-ecosystem: "github-actions"
     allow:
       - dependency-type: "all"
-    assignees:
-      - ${{secrets.MEX_BOT_USER}}
     directory: "/"
     labels:
       - "dependabot"
@@ -14,8 +12,6 @@ updates:
   - package-ecosystem: "pip"
     allow:
       - dependency-type: "all"
-    assignees:
-      - ${{secrets.MEX_BOT_USER}}
     directory: "/"
     labels:
       - "dependabot"

.github/workflows/cookiecutter.yml

@@ -77,10 +77,10 @@ jobs:
           git checkout -b cruft/cookiecutter-template-${template_ref}
           cruft update --skip-apply-ask
           printf '# Changes\n\n- bumped cookiecutter template to %s/commit/%s\n' "$template_url" "$template_ref" > .cruft-pr-body
-          if [[ $(git status --porcelain | grep .rej | wc -c) -ne 0 ]]; then
-            printf '\n# Conflicts\n' > .cruft-pr-body
+          if [[ $(find . -type f -name "*.rej" | wc -l) -ne 0 ]]; then
+            printf '\n# Conflicts\n' >> .cruft-pr-body
           fi
-          git status --porcelain | grep .rej | awk '{print $2;}' | while read -r line ; do
+          find . -type f -name "*.rej" | while read -r line ; do
             printf '\n```' >> .cruft-pr-body
             cat ${line} >> .cruft-pr-body
             printf '```\n' >> .cruft-pr-body

.github/workflows/cve-scan.yml

@@ -32,7 +32,7 @@ jobs:
           cache-name: cache-trivy
         with:
           path: ~/.cache/trivy
-          key: ${{ env.cache-name }}-${{ hashFiles('poetry.lock') }}
+          key: ${{ env.cache-name }}-${{ hashFiles('*.lock') }}
           restore-keys: |
             ${{ env.cache-name }}-
 

.github/workflows/documentation.yml

@@ -39,13 +39,13 @@ jobs:
           restore-keys: |
             ${{ env.cache-name }}-
 
-      - name: Cache poetry
+      - name: Cache environment
         uses: actions/cache@v4
         env:
-          cache-name: cache-poetry
+          cache-name: cache-environment
         with:
           path: ~/.cache/pip
-          key: ${{ env.cache-name }}-${{ hashFiles('poetry.lock') }}
+          key: ${{ env.cache-name }}-${{ hashFiles('*.lock') }}
           restore-keys: |
             ${{ env.cache-name }}-
 

.github/workflows/linting.yml

@@ -34,13 +34,13 @@ jobs:
           restore-keys: |
             ${{ env.cache-name }}-
 
-      - name: Cache poetry
+      - name: Cache environment
         uses: actions/cache@v4
         env:
-          cache-name: cache-poetry
+          cache-name: cache-environment
         with:
           path: ~/.cache/pip
-          key: ${{ env.cache-name }}-${{ hashFiles('poetry.lock') }}
+          key: ${{ env.cache-name }}-${{ hashFiles('*.lock') }}
           restore-keys: |
             ${{ env.cache-name }}-
 

.github/workflows/reviewing.yml

@@ -13,7 +13,7 @@ jobs:
     steps:
       - name: Add assignee
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.WORKFLOW_TOKEN }}
         run: |
           user_name="${{ github.event.pull_request.user.login }}"
           user_type=$(gh api "users/${user_name}" --jq ".type")

.gitignore

@@ -14,6 +14,7 @@ dist/
 downloads/
 eggs/
 .eggs/
+.pdm-python
 lib/
 lib64/
 parts/

.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
       - id: fix-byte-order-marker
         name: byte-order
   - repo: https://github.com/python-poetry/poetry
-    rev: 1.8.1
+    rev: 1.8.2
     hooks:
       - id: poetry-check
         name: poetry

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and
+maintainers pledge to make participation in our project and our community a
+harassment-free experience for everyone, regardless of age, body size, disability,
+ethnicity, sex characteristics, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race, religion,
+or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project team members are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in response to
+any instances of unacceptable behavior.
+
+Project team members have the right and responsibility to remove, edit, or reject
+comments, commits, code, and other contributions that are not aligned to this
+Code of Conduct, or to ban temporarily or permanently any contributor for other
+behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when an
+individual is representing the project or its community in public spaces. Examples of
+representing a project or community include using an official project e-mail address,
+appearing as a project maintainer, or acting as an appointed representative at an online
+or offline event. Representation of a project may be further defined and clarified by
+the project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
+contacting the project team at [email protected]. All complaints will be reviewed and
+investigated and will result in a response that is deemed necessary and appropriate to
+the circumstances. The project team is obligated to maintain confidentiality with regard
+to the reporter of an incident. Further details of specific enforcement policies may be
+posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may
+face temporary or permanent repercussions as determined by project, departmental
+or organizational leadership roles.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

Makefile

@@ -14,7 +14,7 @@ hooks:
 	fi; \
 
 install: setup hooks
-	# run the poetry installation with embedded virtual environment
+	# install packages from lock file in local virtual environment
 	@ echo installing package; \
 	poetry install --no-interaction --sync; \
 

README.md

@@ -52,13 +52,12 @@ components of the MEx project are open-sourced under the same license as well.
 - on unix, consider using pyenv https://github.com/pyenv/pyenv
   - get pyenv `curl https://pyenv.run | bash`
   - install 3.11 `pyenv install 3.11`
-  - create env `pyenv virtualenv 3.11 mex`
-  - go to repo root
-  - use env `pyenv local mex`
+  - switch version `pyenv global 3.11`
   - run `make install`
-- on windows, see https://python-poetry.org/docs/managing-environments
-  - install `python3.11` in your preferred way
-  - go to repo root
+- on windows, consider using pyenv-win https://pyenv-win.github.io/pyenv-win/
+  - follow https://pyenv-win.github.io/pyenv-win/#quick-start
+  - install 3.11 `pyenv install 3.11`
+  - switch version `pyenv global 3.11`
   - run `.\mex.bat install`
 
 ### linting and testing
@@ -73,15 +72,15 @@ components of the MEx project are open-sourced under the same license as well.
 ### updating dependencies
 
 - update boilerplate files with `cruft update`
-- update global dependencies in `requirements.txt` manually
+- update global requirements in `requirements.txt` manually
 - update git hooks with `pre-commit autoupdate`
 - show outdated dependencies with `poetry show --outdated`
 - update dependencies in poetry using `poetry update --lock`
-- update github actions manually in `.github/workflows/*.yml`
+- update github actions in `.github/workflows/*.yml` manually
 
 ### creating release
 
-- update version, eg `poetry version minor`
-- commit update `git commit --message "..." pyproject.toml`
+- update version in `pyproject.toml` and `CHANGELOG.md`
+- commit update `git commit --message "..."`
 - create a tag `git tag ...`
 - push `git push --follow-tags`

mex.bat

@@ -20,7 +20,7 @@ if "%CI%"=="" (
     if %errorlevel% neq 0 exit /b %errorlevel%
 )
 
-@REM run the poetry installation with embedded virtual environment
+@REM install packages from lock file in local virtual environment
 echo installing package
 poetry install --no-interaction --sync
 exit /b %errorlevel%

requirements.txt

@@ -1,4 +1,4 @@
 cruft==2.15.0
 poetry==1.8.2
 pre-commit==3.6.2
-wheel==0.42.0
+wheel==0.43.0