From 6831fc1d9c87bcd5720dfc98d77ee60bd7467e57 Mon Sep 17 00:00:00 2001 From: hf-kklein Date: Wed, 12 Aug 2026 05:16:51 +0000 Subject: [PATCH 1/2] Fix stale tox references in create_env_file docstrings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The migration to uv removed tox.ini, but both create_env_file.py docstrings still claimed "used in all tox environments except the linting environment". - postgresql_db/create_env_file.py: describe the real caller — it is run as a CI workflow step (`uv run python -m borm.db.postgresql_db.create_env_file` in unittests/coverage/integrationtests/python-publish) and documented in the README. - mysql_db/create_env_file.py: has no CI caller (the mysql backend is not wired into any workflow, unlike postgres). Reworded to describe manual/local invocation instead of claiming a caller it does not have. See PR comment for the open wire-up-vs-remove decision. Closes #278 Co-Authored-By: Claude Opus 4.8 --- src/borm/db/mysql_db/create_env_file.py | 3 ++- src/borm/db/postgresql_db/create_env_file.py | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/borm/db/mysql_db/create_env_file.py b/src/borm/db/mysql_db/create_env_file.py index 2811f65..b9b8127 100644 --- a/src/borm/db/mysql_db/create_env_file.py +++ b/src/borm/db/mysql_db/create_env_file.py @@ -1,7 +1,8 @@ """ This python script copies the env.example to .env if .env does not already exists. This is similar to the bash command `mv example.env .env`. -It is used in all tox environments except the linting environment. +Run it manually via ``uv run python -m borm.db.mysql_db.create_env_file`` for local MySQL setup; +unlike the PostgreSQL variant it is not currently invoked by any CI workflow. """ from pathlib import Path diff --git a/src/borm/db/postgresql_db/create_env_file.py b/src/borm/db/postgresql_db/create_env_file.py index 914da06..c4e7ed1 100644 --- a/src/borm/db/postgresql_db/create_env_file.py +++ b/src/borm/db/postgresql_db/create_env_file.py @@ -1,7 +1,9 @@ """ This python script copies the env.example to .env if .env does not already exists. This is similar to the bash command `mv example.env .env`. -It is used in all tox environments except the linting environment. +It is run as a CI workflow step (``uv run python -m borm.db.postgresql_db.create_env_file`` in +unittests.yml, coverage.yml, integrationtests.yml and python-publish.yml) and documented for +local setup in the README. """ from pathlib import Path From e21d6fa6568ba8ba348840f65b67f4b6c6cb25f7 Mon Sep 17 00:00:00 2001 From: hf-kklein Date: Wed, 12 Aug 2026 05:21:38 +0000 Subject: [PATCH 2/2] Fix docstring filename/verb inaccuracies flagged by Copilot The script copies .env.example (a dotfile) to .env via copyfile, so the docstring should say ".env.example" and "cp .env.example .env" (not "env.example" / "mv example.env .env"); also "exists" -> "exist". Co-Authored-By: Claude Opus 4.8 --- src/borm/db/mysql_db/create_env_file.py | 4 ++-- src/borm/db/postgresql_db/create_env_file.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/borm/db/mysql_db/create_env_file.py b/src/borm/db/mysql_db/create_env_file.py index b9b8127..dea42ec 100644 --- a/src/borm/db/mysql_db/create_env_file.py +++ b/src/borm/db/mysql_db/create_env_file.py @@ -1,6 +1,6 @@ """ -This python script copies the env.example to .env if .env does not already exists. -This is similar to the bash command `mv example.env .env`. +This python script copies .env.example to .env if .env does not already exist. +This is similar to the shell command `cp .env.example .env`. Run it manually via ``uv run python -m borm.db.mysql_db.create_env_file`` for local MySQL setup; unlike the PostgreSQL variant it is not currently invoked by any CI workflow. """ diff --git a/src/borm/db/postgresql_db/create_env_file.py b/src/borm/db/postgresql_db/create_env_file.py index c4e7ed1..5575b24 100644 --- a/src/borm/db/postgresql_db/create_env_file.py +++ b/src/borm/db/postgresql_db/create_env_file.py @@ -1,6 +1,6 @@ """ -This python script copies the env.example to .env if .env does not already exists. -This is similar to the bash command `mv example.env .env`. +This python script copies .env.example to .env if .env does not already exist. +This is similar to the shell command `cp .env.example .env`. It is run as a CI workflow step (``uv run python -m borm.db.postgresql_db.create_env_file`` in unittests.yml, coverage.yml, integrationtests.yml and python-publish.yml) and documented for local setup in the README.