Complete stage 1 tooling and metadata migration

Author: Krolken

.github/workflows/docs.yml

@@ -6,6 +6,13 @@ on:
       - master
       - main
 
+permissions:
+  contents: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -20,13 +27,12 @@ jobs:
           enable-cache: true
           cache-dependency-glob: |
             pyproject.toml
-            setup.py
+            uv.lock
           ignore-nothing-to-cache: true
 
-      - name: Install dependencies
+      - name: Install docs dependencies
         run: |
-          uv venv .venv --python 3.13 --clear
-          uv pip install mkdocs mkdocs-material
+          uv sync --extra docs --python 3.13 --locked
 
       - name: Deploy docs
         run: uv run mkdocs gh-deploy --force

.github/workflows/test.yml

@@ -4,6 +4,13 @@ on:
   push:
   pull_request:
 
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
   lint:
     runs-on: ubuntu-latest
@@ -20,17 +27,21 @@ jobs:
           enable-cache: true
           cache-dependency-glob: |
             pyproject.toml
-            setup.py
+            uv.lock
           ignore-nothing-to-cache: true
 
+      - name: Install development dependencies
+        run: |
+          uv sync --extra dev --python 3.13 --locked
+
       - name: Run pre-commit on changed files
         run: |
           if [ "${{ github.event_name }}" = "pull_request" ]; then
-            uvx pre-commit run --from-ref "${{ github.event.pull_request.base.sha }}" --to-ref "${{ github.event.pull_request.head.sha }}"
+            uv run pre-commit run --from-ref "${{ github.event.pull_request.base.sha }}" --to-ref "${{ github.event.pull_request.head.sha }}"
           elif [ "${{ github.event.before }}" != "0000000000000000000000000000000000000000" ]; then
-            uvx pre-commit run --from-ref "${{ github.event.before }}" --to-ref "${{ github.sha }}"
+            uv run pre-commit run --from-ref "${{ github.event.before }}" --to-ref "${{ github.sha }}"
           else
-            uvx pre-commit run --all-files
+            uv run pre-commit run --all-files
           fi
 
   test:
@@ -51,13 +62,12 @@ jobs:
           enable-cache: true
           cache-dependency-glob: |
             pyproject.toml
-            setup.py
+            uv.lock
           ignore-nothing-to-cache: true
 
-      - name: Install dependencies
+      - name: Install test dependencies
         run: |
-          uv venv .venv --python ${{ matrix.python-version }} --clear
-          uv pip install -e ".[test]"
+          uv sync --extra test --python ${{ matrix.python-version }} --locked
 
       - name: Test with pytest
         run: |

HISTORY.md

@@ -10,6 +10,8 @@ and this project adheres to [Calendar Versioning](https://calver.org/)
 
 
 ### Added
+* Added `scripts/release.sh` for maintainer-managed local releases using
+  `uv build` and `twine` uploads.
 
 ### Changed
 * `DlmsClient` now tracks and increments invoke-id values and sets explicit
@@ -21,10 +23,16 @@ and this project adheres to [Calendar Versioning](https://calver.org/)
 * Migrated CI and docs workflows from `pip`-based installs to `uv`.
 * Updated GitHub Actions workflow action versions to Node 24-compatible releases
   and set explicit uv cache dependency globs to avoid cache invalidation warnings.
+* Migrated package metadata to `pyproject.toml` (PEP 621), added `uv.lock`, and
+  switched CI/docs installs to `uv sync --locked`.
+* Added explicit GitHub Actions permissions and concurrency settings for safer and
+  less redundant workflow execution.
 
 ### Deprecated
 
 ### Removed
+* Removed legacy `setup.py` build script in favor of `pyproject.toml`
+  packaging metadata.
 
 ### Fixed
 
@@ -129,7 +137,7 @@ will allow for more versions.
 
 * Some DLMS over TCP implementations will return partial data. The
   `BlockingTcpTransport` now keeps on trying to read the data until all data is
-  received. Fixes [#35](https://github.com/pwitab/dlms-cosem/issues/35).
+  received. Fixes [#35](https://github.com/u9n/dlms-cosem/issues/35).
 * Fixed a bug in the HDLC layer that prevented correct sending of segmented information
   frames.
 
@@ -144,11 +152,11 @@ will allow for more versions.
 
 ### Fixed
 
-* Fixed [#23](https://github.com/pwitab/dlms-cosem/issues/23). Typo in A-XDR Parser.
+* Fixed [#23](https://github.com/u9n/dlms-cosem/issues/23). Typo in A-XDR Parser.
   Just referenced the function and did not call it. Now DLMS data is interpreted
   correctly.
 
-* Fixed [#20](https://github.com/pwitab/dlms-cosem/issues/20). It was possible that not
+* Fixed [#20](https://github.com/u9n/dlms-cosem/issues/20). It was possible that not
   calling the .shutdown() on socket before disconnecting made remote modems on meters,
   that have an embedded TCP/IP stack, keep the socket open and blocking subsequent calls.
 

README.md

@@ -18,6 +18,12 @@ If you are not using a project-managed environment, you can also run:
 uv pip install dlms-cosem
 ```
 
+Or with pip:
+
+```bash
+pip install dlms-cosem
+```
+
 # Documentation
 
 Full documentation can be found at [www.dlms.dev](https://www.dlms.dev)
@@ -138,18 +144,46 @@ please contact us at `info(at)pwit.se`.
 
 # Development
 
+This library uses an `uv`-first development workflow.
+
+```bash
+uv sync --extra dev
+uv run pytest
+uvx pre-commit run --all-files
+```
+
+For maintainers, local releases can be built and uploaded with:
+
+```bash
+scripts/release.sh --repository testpypi
+# or
+scripts/release.sh
+```
+
 This library is developed by Palmlund Wahlgren Innovative Technology AB. We are
 based in Sweden and are members of the DLMS User Association.
 
 If you find a bug please raise an issue on Github.
 
+## Contribution policy
+
+We welcome bug reports, feature requests, and design discussions through GitHub
+Issues.
+
+To reduce security and maintenance risk in this protocol implementation, we do
+not directly accept external code contributions for merge.
+
+You are still welcome to open a pull request to illustrate an approach,
+provide examples, or share tests/reproduction steps. We review these proposals,
+but the maintainers implement and merge the final production code.
+
 We add features depending on our own, and our clients use cases. If you
 need a feature implemented please contact us.
 
 # Training / Consultancy / Commercial Support / Services
 
 We offer consultancy service and training services around this library and general DLMS/COSEM.
-If you are interested in our services just reach at `ìnfo(at)pwit.se`
+If you are interested in our services just reach at `info(at)pwit.se`
 
 The library is an important part of our [Smart meter platform Utilitarian, https://utilitarian.io](https://utilitarian.io). If you need to
 collect data from a lot of DLMS devices or meters, deploying Utilitarian might be the smoothest

pyproject.toml

@@ -1,3 +1,67 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "dlms-cosem"
+version = "2026.1.0"
+description = "A Python library for DLMS/COSEM"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "Business Source License 1.1" }
+authors = [
+  { name = "Henrik Palmlund Wahlgren @ Palmlund Wahlgren Innovative Technology AB", email = "henrik@pwit.se" },
+]
+maintainers = [
+  { name = "Henrik Palmlund Wahlgren @ Palmlund Wahlgren Innovative Technology AB", email = "henrik@pwit.se" },
+]
+keywords = ["AMR", "Metering", "smart meters", "MDM", "dlms", "cosem"]
+classifiers = [
+  "Intended Audience :: Developers",
+  "Natural Language :: English",
+  "License :: Other/Proprietary License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: Communications",
+]
+dependencies = [
+  "attrs>=22.2.0",
+  "pyserial>=3.5",
+  "cryptography>=35.0.0",
+  "asn1crypto>=1.4.0",
+  "python-dateutil>=2.8.1",
+  "typing-extensions>=3.10",
+  "structlog>=22.1.0",
+]
+
+[project.optional-dependencies]
+docs = ["mkdocs", "mkdocs-material"]
+test = ["pytest", "pytest-cov", "pytest-sugar"]
+dev = [
+  "pre-commit",
+  "mkdocs",
+  "mkdocs-material",
+  "pytest",
+  "pytest-cov",
+  "pytest-sugar",
+]
+
+[project.urls]
+Documentation = "https://www.dlms.dev/"
+"Bug Tracker" = "https://github.com/u9n/dlms-cosem/issues"
+"Source Code" = "https://github.com/u9n/dlms-cosem"
+
+[tool.setuptools.packages.find]
+exclude = ["tests", "tests.*"]
+
 [tool.black]
 target-version = ["py39"]
 include = '\.pyi?$'

scripts/release.sh

@@ -0,0 +1,125 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
+REPO_ROOT="$(cd -- "${SCRIPT_DIR}/.." && pwd)"
+cd "${REPO_ROOT}"
+
+usage() {
+  cat <<'EOF'
+Usage: scripts/release.sh [options]
+
+Build and upload a release with uv + twine from a clean git working tree.
+
+Options:
+  --repository <name>  Twine repository name (default: pypi, e.g. testpypi)
+  --skip-checks        Skip sync/tests/pre-commit checks before build
+  --skip-tag           Do not create git tag for the current project version
+  -h, --help           Show this help
+
+Examples:
+  scripts/release.sh
+  scripts/release.sh --repository testpypi
+  scripts/release.sh --skip-checks --skip-tag
+EOF
+}
+
+repository="pypi"
+skip_checks="false"
+skip_tag="false"
+
+while [[ $# -gt 0 ]]; do
+  case "$1" in
+    --repository)
+      repository="$2"
+      shift 2
+      ;;
+    --skip-checks)
+      skip_checks="true"
+      shift
+      ;;
+    --skip-tag)
+      skip_tag="true"
+      shift
+      ;;
+    -h|--help)
+      usage
+      exit 0
+      ;;
+    *)
+      echo "Unknown argument: $1" >&2
+      usage
+      exit 1
+      ;;
+  esac
+done
+
+if ! command -v uv >/dev/null 2>&1; then
+  echo "uv is required but was not found in PATH." >&2
+  exit 1
+fi
+
+if ! command -v git >/dev/null 2>&1; then
+  echo "git is required but was not found in PATH." >&2
+  exit 1
+fi
+
+if [[ -n "$(git status --porcelain)" ]]; then
+  echo "Working tree is not clean. Commit/stash changes before releasing." >&2
+  git status --short
+  exit 1
+fi
+
+version="$({
+python3 - <<'PY'
+from pathlib import Path
+
+try:
+    import tomllib
+except ModuleNotFoundError:  # pragma: no cover
+    import tomli as tomllib
+
+project = tomllib.loads(Path("pyproject.toml").read_text())
+print(project["project"]["version"])
+PY
+} | tr -d '[:space:]')"
+
+if [[ -z "${version}" ]]; then
+  echo "Unable to read project.version from pyproject.toml" >&2
+  exit 1
+fi
+
+echo "Preparing release ${version} (repository: ${repository})"
+
+if [[ "${skip_checks}" != "true" ]]; then
+  echo "Running quality checks..."
+  uv sync --extra dev --locked
+  uv run pytest -q
+  uv run pre-commit run --all-files
+fi
+
+echo "Building artifacts..."
+rm -rf dist build
+uv build
+
+echo "Validating artifacts..."
+uvx twine check dist/*
+
+echo "Uploading artifacts to ${repository}..."
+if [[ "${repository}" == "pypi" ]]; then
+  uvx twine upload dist/*
+else
+  uvx twine upload --repository "${repository}" dist/*
+fi
+
+if [[ "${skip_tag}" != "true" ]]; then
+  if git rev-parse -q --verify "refs/tags/${version}" >/dev/null; then
+    echo "Tag ${version} already exists. Skipping tag creation." >&2
+  else
+    git tag -a "${version}" -m "Release ${version}"
+    echo "Created tag ${version}."
+    echo "Push it with: git push origin ${version}"
+  fi
+fi
+
+echo "Release ${version} complete."