mex-release 0.2.0__tar.gz

mex_release-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Robert Koch-Institut
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mex_release-0.2.0/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.1
+Name: mex-release
+Version: 0.2.0
+Summary: Create new release with `pdm release VERSION`
+Author-Email: MEx Team <mex@rki.de>
+License: MIT License
+         
+         Copyright (c) 2024 Robert Koch-Institut
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+         
+Project-URL: Repository, https://github.com/robert-koch-institut/mex-release
+Requires-Python: <3.13,>=3.11
+Requires-Dist: pdm<3.0,>=2.13.2
+Provides-Extra: dev
+Requires-Dist: ipdb<1,>=0.13.13; extra == "dev"
+Requires-Dist: mypy<2,>=1.11.0; extra == "dev"
+Requires-Dist: ruff<1,>=0.5.4; extra == "dev"
+Description-Content-Type: text/markdown
+
+# MEx release
+
+Create new release with `pdm release VERSION`
+
+[![cookiecutter](https://github.com/robert-koch-institut/mex-release/actions/workflows/cookiecutter.yml/badge.svg)](https://github.com/robert-koch-institut/mex-template)
+[![cve-scan](https://github.com/robert-koch-institut/mex-release/actions/workflows/cve-scan.yml/badge.svg)](https://github.com/robert-koch-institut/mex-release/actions/workflows/cve-scan.yml)
+[![linting](https://github.com/robert-koch-institut/mex-release/actions/workflows/linting.yml/badge.svg)](https://github.com/robert-koch-institut/mex-release/actions/workflows/linting.yml)
+[![open-code](https://github.com/robert-koch-institut/mex-release/actions/workflows/open-code.yml/badge.svg)](https://gitlab.opencode.de/robert-koch-institut/mex/mex-release)
+
+## project
+
+The Metadata Exchange (MEx) project is committed to improve the retrieval of RKI
+research data and projects. How? By focusing on metadata: instead of providing the
+actual research data directly, the MEx metadata catalog captures descriptive information
+about research data and activities. On this basis, we want to make the data FAIR[^1] so
+that it can be shared with others.
+
+Via MEx, metadata will be made findable, accessible and shareable, as well as available
+for further research. The goal is to get an overview of what research data is available,
+understand its context, and know what needs to be considered for subsequent use.
+
+RKI cooperated with D4L data4life gGmbH for a pilot phase where the vision of a
+FAIR metadata catalog was explored and concepts and prototypes were developed.
+The partnership has ended with the successful conclusion of the pilot phase.
+
+After an internal launch, the metadata will also be made publicly available and thus be
+available to external researchers as well as the interested (professional) public to
+find research data from the RKI.
+
+For further details, please consult our
+[project page](https://www.rki.de/DE/Content/Forsch/MEx/MEx_node.html).
+
+[^1]: FAIR is referencing the so-called
+[FAIR data principles](https://www.go-fair.org/fair-principles/) – guidelines to make
+data Findable, Accessible, Interoperable and Reusable.
+
+**Contact** \
+For more information, please feel free to email us at [mex@rki.de](mailto:mex@rki.de).
+
+### Publisher of this document
+**Robert Koch-Institut** \
+Nordufer 20 \
+13353 Berlin \
+Germany
+
+## package
+
+Create a new release, including changelog rollover, project version bump, commit, tag
+and push.
+
+## license
+
+This package is licensed under the [MIT license](/LICENSE). All other software
+components of the MEx project are open-sourced under the same license as well.
+
+## development
+
+### installation
+
+- on unix, consider using pyenv https://github.com/pyenv/pyenv
+  - get pyenv `curl https://pyenv.run | bash`
+  - install 3.11 `pyenv install 3.11`
+  - switch version `pyenv global 3.11`
+  - run `make install`
+- 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
+
+- run all linters with `pdm lint`
+- run only unit tests with `pdm unit`
+- run unit and integration tests with `pdm test`
+
+### updating dependencies
+
+- update boilerplate files with `cruft update`
+- update global requirements in `requirements.txt` manually
+- update git hooks with `pre-commit autoupdate`
+- update package dependencies using `pdm update-all`
+- update github actions in `.github/workflows/*.yml` manually
+
+### creating release
+
+- run `pdm release RULE` to release a new version where RULE determines which part of
+  the version to update and is one of `major`, `minor`, `patch`.
+
+### container workflow
+
+- build image with `make image`
+- run directly using docker `make run`
+- start with docker compose `make start`
+
+## commands
+
+- run `pdm release VERSION` to release a new version where VERSION matches the regular
+ expression: `\d{1,4}\.\d{1,4}\.\d{1,4}`.

mex_release-0.2.0/README.md

@@ -0,0 +1,99 @@
+# MEx release
+
+Create new release with `pdm release VERSION`
+
+[![cookiecutter](https://github.com/robert-koch-institut/mex-release/actions/workflows/cookiecutter.yml/badge.svg)](https://github.com/robert-koch-institut/mex-template)
+[![cve-scan](https://github.com/robert-koch-institut/mex-release/actions/workflows/cve-scan.yml/badge.svg)](https://github.com/robert-koch-institut/mex-release/actions/workflows/cve-scan.yml)
+[![linting](https://github.com/robert-koch-institut/mex-release/actions/workflows/linting.yml/badge.svg)](https://github.com/robert-koch-institut/mex-release/actions/workflows/linting.yml)
+[![open-code](https://github.com/robert-koch-institut/mex-release/actions/workflows/open-code.yml/badge.svg)](https://gitlab.opencode.de/robert-koch-institut/mex/mex-release)
+
+## project
+
+The Metadata Exchange (MEx) project is committed to improve the retrieval of RKI
+research data and projects. How? By focusing on metadata: instead of providing the
+actual research data directly, the MEx metadata catalog captures descriptive information
+about research data and activities. On this basis, we want to make the data FAIR[^1] so
+that it can be shared with others.
+
+Via MEx, metadata will be made findable, accessible and shareable, as well as available
+for further research. The goal is to get an overview of what research data is available,
+understand its context, and know what needs to be considered for subsequent use.
+
+RKI cooperated with D4L data4life gGmbH for a pilot phase where the vision of a
+FAIR metadata catalog was explored and concepts and prototypes were developed.
+The partnership has ended with the successful conclusion of the pilot phase.
+
+After an internal launch, the metadata will also be made publicly available and thus be
+available to external researchers as well as the interested (professional) public to
+find research data from the RKI.
+
+For further details, please consult our
+[project page](https://www.rki.de/DE/Content/Forsch/MEx/MEx_node.html).
+
+[^1]: FAIR is referencing the so-called
+[FAIR data principles](https://www.go-fair.org/fair-principles/) – guidelines to make
+data Findable, Accessible, Interoperable and Reusable.
+
+**Contact** \
+For more information, please feel free to email us at [mex@rki.de](mailto:mex@rki.de).
+
+### Publisher of this document
+**Robert Koch-Institut** \
+Nordufer 20 \
+13353 Berlin \
+Germany
+
+## package
+
+Create a new release, including changelog rollover, project version bump, commit, tag
+and push.
+
+## license
+
+This package is licensed under the [MIT license](/LICENSE). All other software
+components of the MEx project are open-sourced under the same license as well.
+
+## development
+
+### installation
+
+- on unix, consider using pyenv https://github.com/pyenv/pyenv
+  - get pyenv `curl https://pyenv.run | bash`
+  - install 3.11 `pyenv install 3.11`
+  - switch version `pyenv global 3.11`
+  - run `make install`
+- 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
+
+- run all linters with `pdm lint`
+- run only unit tests with `pdm unit`
+- run unit and integration tests with `pdm test`
+
+### updating dependencies
+
+- update boilerplate files with `cruft update`
+- update global requirements in `requirements.txt` manually
+- update git hooks with `pre-commit autoupdate`
+- update package dependencies using `pdm update-all`
+- update github actions in `.github/workflows/*.yml` manually
+
+### creating release
+
+- run `pdm release RULE` to release a new version where RULE determines which part of
+  the version to update and is one of `major`, `minor`, `patch`.
+
+### container workflow
+
+- build image with `make image`
+- run directly using docker `make run`
+- start with docker compose `make start`
+
+## commands
+
+- run `pdm release VERSION` to release a new version where VERSION matches the regular
+ expression: `\d{1,4}\.\d{1,4}\.\d{1,4}`.

mex_release-0.2.0/pyproject.toml

@@ -0,0 +1,178 @@
+[project]
+name = "mex-release"
+version = "0.2.0"
+description = "Create new release with `pdm release VERSION`"
+authors = [
+    { name = "MEx Team", email = "mex@rki.de" },
+]
+requires-python = "<3.13,>=3.11"
+dependencies = [
+    "pdm>=2.13.2,<3.0",
+]
+
+[project.readme]
+file = "README.md"
+content-type = "text/markdown"
+
+[project.license]
+file = "LICENSE"
+
+[project.urls]
+Repository = "https://github.com/robert-koch-institut/mex-release"
+
+[project.optional-dependencies]
+dev = [
+    "ipdb>=0.13.13,<1",
+    "mypy>=1.11.0,<2",
+    "ruff>=0.5.4,<1",
+]
+
+[project.entry-points.pdm]
+release = "release:release"
+
+[tool.cruft]
+template = "https://github.com/robert-koch-institut/mex-template"
+skip = [
+    "CHANGELOG.md",
+    "mex",
+    "tests",
+]
+
+[tool.ipdb]
+context = 5
+
+[tool.mypy]
+python_version = "3.11"
+show_error_codes = true
+strict = true
+plugins = [
+    "pydantic.mypy",
+]
+
+[tool.pdm]
+distribution = true
+
+[tool.pdm.scripts.update-all]
+cmd = "pdm update --group :all --update-all --save-compatible"
+
+[tool.pdm.scripts.lock-all]
+cmd = "pdm lock --group :all --python='==3.11.*'"
+
+[tool.pdm.scripts.install-all]
+cmd = "pdm install --group :all --frozen-lockfile"
+
+[tool.pdm.scripts.export-all]
+cmd = "pdm export --group :all --no-hashes -f requirements"
+
+[tool.pdm.scripts.apidoc]
+cmd = "pdm run sphinx-apidoc -f -o docs/source mex"
+
+[tool.pdm.scripts.sphinx]
+cmd = "pdm run sphinx-build -aE -b dirhtml docs docs/dist"
+
+[tool.pdm.scripts.doc]
+composite = [
+    "apidoc",
+    "sphinx",
+]
+
+[tool.pdm.scripts.wheel]
+cmd = "pdm build --no-sdist"
+
+[tool.pdm.scripts.mypy-daemon]
+cmd = "pdm run dmypy run --timeout 7200 -- mex"
+
+[tool.pdm.scripts.lint]
+cmd = "pre-commit run --all-files"
+
+[tool.pdm.scripts.unit]
+cmd = "pdm run pytest -m 'not integration'"
+
+[tool.pdm.scripts.test]
+cmd = "pdm run pytest --numprocesses=auto --dist=worksteal"
+
+[tool.pdm.scripts.all]
+composite = [
+    "install-all",
+    "lint",
+    "test",
+    "doc",
+]
+
+[tool.pydantic-mypy]
+warn_untyped_fields = true
+
+[tool.pytest.ini_options]
+addopts = [
+    "--verbose",
+    "--cov",
+    "--no-cov-on-fail",
+    "--cov-report=term-missing:skip-covered",
+    "--cov-fail-under=95",
+    "--cov-branch",
+    "--pdbcls=IPython.terminal.debugger:TerminalPdb",
+    "--random-order-bucket=global",
+]
+markers = "integration: mark a test as integration test"
+
+[tool.ruff]
+fix = true
+line-length = 88
+show-fixes = true
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ruff.lint]
+ignore = [
+    "D100",
+    "D104",
+    "D106",
+    "D203",
+    "D213",
+    "D406",
+    "D407",
+    "D413",
+    "N805",
+    "N815",
+    "RUF012",
+]
+select = [
+    "A",
+    "B",
+    "C90",
+    "D",
+    "E",
+    "ERA",
+    "F",
+    "I",
+    "N",
+    "PERF",
+    "RET",
+    "RUF",
+    "S",
+    "T10",
+    "T20",
+    "UP",
+    "W",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+    "D101",
+    "D102",
+    "D103",
+    "D107",
+    "E501",
+    "N807",
+    "S101",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[build-system]
+requires = [
+    "pdm-backend==2.4.1",
+]
+build-backend = "pdm.backend"

mex_release-0.2.0/release.py

@@ -0,0 +1,147 @@
+import argparse
+import re
+import subprocess
+from datetime import date
+
+from pdm import termui
+from pdm.cli.commands.base import BaseCommand
+from pdm.core import Core
+from pdm.project import Project
+from pdm.project.project_file import PyProject
+
+CHANGELOG_TEMPLATE = """
+## [Unreleased]
+
+### Added
+
+### Changes
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+## [{version}] - {date}
+"""
+
+
+class ReleaseCommand(BaseCommand):
+    """Set project version to the given version."""
+
+    def add_arguments(self, parser: argparse.ArgumentParser) -> None:
+        """Manipulate the argument parser to add more arguments."""
+        parser.add_argument(
+            "bump",
+            choices=("major", "minor", "patch"),
+            default="patch",
+            help="part of the project version to update",
+        )
+
+    def handle(self, project: Project, options: argparse.Namespace) -> None:
+        """Execute the release command."""
+        releaser = Releaser(project.pyproject, options.bump)
+        releaser.release()
+
+
+class Releaser:
+    """Wrap the release functionality in a single object."""
+
+    def __init__(self, pyproject: PyProject, bump: str) -> None:
+        """Create a new releaser instance."""
+        self.bump = bump
+        self.pyproject = pyproject
+
+    def run(self, *args: str) -> str:
+        """Run a command as subproccess, first print it, later print the output."""
+        self.pyproject.ui.echo(" ".join(args))
+        # use noqa because we check user input (bump) and all other args are hard
+        # coded
+        stdout = subprocess.check_output(args).decode("utf-8")  # noqa: S603
+        self.pyproject.ui.echo(
+            stdout,
+            verbosity=termui.Verbosity.NORMAL,
+        )
+        return stdout.strip()
+
+    def check_working_tree(self) -> None:
+        """Only continue if working tree is empty."""
+        if self.run("git", "status", "--short"):
+            raise RuntimeError(
+                "Working tree is dirty. Can only release clean working tree."
+            )
+
+    def check_default_branch(self) -> None:
+        """Only continue if default branch is checked out."""
+        git_branch = self.run("git", "rev-parse", "--abbrev-ref", "HEAD")
+        git_origin_branches = self.run("git", "remote", "show", "origin")
+        git_default_branch = re.findall(
+            r"HEAD branch: (\S+)", str(git_origin_branches)
+        )[0]
+        if git_branch != git_default_branch:
+            raise RuntimeError(
+                "Not on default branch. Can only release on default branch."
+            )
+
+    def check_version_string(self) -> None:
+        """Validate the version string to format `0.3.14`."""
+        if not re.match(
+            r"\d{1,4}\.\d{1,4}\.\d{1,4}", self.pyproject.metadata["version"]
+        ):
+            raise RuntimeError("Current version string does not match expected format.")
+
+    def release(self) -> None:
+        """Execute the release command."""
+        self.check_working_tree()
+        self.check_default_branch()
+        self.check_version_string()
+
+        # update project version in toml
+        major, minor, patch = self.pyproject.metadata["version"].split(".")
+        if self.bump == "major":
+            new_version = f"{int(major) + 1}.0.0"
+        elif self.bump == "minor":
+            new_version = f"{major}.{int(minor) + 1}.0"
+        elif self.bump == "patch":
+            new_version = f"{major}.{minor}.{int(patch) + 1}"
+        else:
+            raise Exception("Unexpected bump value.")
+        self.pyproject.metadata["version"] = new_version
+        self.pyproject.write()
+
+        # rollover changelog sections
+        with open("CHANGELOG.md") as fh:
+            changelog = fh.read()
+        # remove empty subsections
+        changelog = re.sub(r"^### [A-Za-z]+\s+(?=#)", "", changelog, flags=re.MULTILINE)
+        # add a new unreleased section
+        changelog = changelog.replace(
+            "\n## [Unreleased]\n",
+            CHANGELOG_TEMPLATE.format(version=new_version, date=date.today()),
+        )
+        with open("CHANGELOG.md", "w") as fh:
+            fh.write(changelog)
+        self.pyproject.ui.echo(
+            "Changes are written to [success]CHANGELOG.md[/].",
+            verbosity=termui.Verbosity.NORMAL,
+        )
+
+        # commit, tag and push
+        self.run(
+            "git",
+            "commit",
+            "-m",
+            f"bump version to {new_version}",
+            "CHANGELOG.md",
+            "pyproject.toml",
+        )
+        self.run("git", "tag", f"{new_version}")
+        self.run("git", "push")
+        self.run("git", "push", "--tags")
+
+
+def release(core: Core) -> None:
+    """Register the release command as a pdm command."""
+    core.register_command(ReleaseCommand, "release")