Fix scripts to run under uv correctly (#174)

rhysyngsun · web-flow · commit 5d3260f76a79 · 2025-01-09T20:25:30.000-05:00
* Fix scripts to run under uv correctly

* Fixes

* Fix detection of changelog files

* Remove py3.12
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -55,7 +55,7 @@ jobs:
 
     - name: Changelog
       if: ${{ !contains(github.event.head_commit.author, 'renovate') }}
-      run: PYTHONPATH=build-support/bin uv run build changelog check
+      run: uv run scripts/changelog.py check
 
       # - name: Upload coverage to CodeCov
       #   uses: codecov/codecov-action@v1
diff --git a/Dockerfile b/Dockerfile
@@ -41,7 +41,6 @@ WORKDIR /home/dev/src
 FROM uv as release
 
 USER dev
-ENV PYTHONPATH="build-support/bin/"
 
 WORKDIR /home/dev
 RUN mkdir -m 0750 .ssh
diff --git a/README.md b/README.md
@@ -12,10 +12,6 @@ This set of libraries is managed using [uv](https://docs.astral.sh/uv/).
 - Install `uv` as described in the manual: https://docs.astral.sh/uv/
 - Bootstrap the `uv` environment: `uv python install 3.11 ; uv sync`
 
-> [!WARNING]
-> If you're running `uv` locally, any calls to the `build` command will need help.
-> Prepend `PYTHONPATH=build-support/bin` to the command so uv will launch it properly.
-
 #### Use the Docker Compose environment (recommended)
 
 The Compose environment includes a container for general use called `shell` and one specifically for building releases called `release`. In either case, you'll get a shell with `uv` already set up, and with a PostgreSQL database available.
@@ -37,7 +33,7 @@ The `release` container is special and is set up to run `build` commands, includ
 **Using:**
 1. Build the images, so the source code in the image is up to date: `docker compose build`
 2. Get a shell: `docker compose run --rm -ti release bash`
-3. Run your command: `uv run build release create etc. etc. etc.`
+3. Run your command: `uv run scripts/release.py create` etc. etc. etc.
 4. If you've done things that involve Git, make sure you `git pull` when you leave the session.
 
 ### Navigating this repository
@@ -89,7 +85,7 @@ Run `uv run pytest`. This should run all the tests. If you want to run a specifi
 
 We maintain changelogs in `changelog.d/` directories with each app. To create a new changelog for your changes, run:
 
-- `uv run build changelog create --app APPNAME`
+- `uv run scripts/changelog.py create --app APPNAME`
   - `APPNAME`: the name of an application directory
 
 Note warning above about `PYTHONPATH`. You will need to adjust permissions/ownership on the new file if you're using the Compose setup.
@@ -102,7 +98,7 @@ Changelogs are maintained according to [Keep a Changelog](https://keepachangelog
 Versioning uses a date-based versioning scheme with incremental builds on the same day.
 Version tags follow `{package-name}/v{version}`
 To perform a release, run:
-- `uv run build release create --app APPNAME --push`:
+- `uv run scripts/release.py create --app APPNAME --push`:
   - `APPNAME`: the name of an application directory
 
 `release` expects to be run on the `main` branch and it expects you to not have changes pending.
diff --git a/build-support/bin/mitol/build_support/cli.py b/build-support/bin/mitol/build_support/cli.py
diff --git a/build-support/bin/mitol/build_support/commands/version.py b/build-support/bin/mitol/build_support/commands/version.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -28,9 +28,6 @@ requires-python = ">= 3.8"
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
-[project.scripts]
-build = "mitol.build_support.cli:cli"
-
 [tool.uv]
 managed = true
 dev-dependencies = [
diff --git a/scripts/__init__.py b/scripts/__init__.py
diff --git a/scripts/apps.py b/scripts/apps.py
@@ -7,17 +7,12 @@
 
 import toml
 
-from mitol.build_support.contextlib import chdir
-
-SOURCE_PATH = "src/"
+from scripts.contextlibs import chdir
 
 
 def get_source_dir() -> Path:
     """Get the source directory"""
-    source_dir = Path.cwd()
-    if SOURCE_PATH not in str(source_dir):
-        source_dir = source_dir / SOURCE_PATH
-    return source_dir
+    return Path(__file__).parent.parent / "src"
 
 
 def get_app_dir(path: str) -> Path:
diff --git a/scripts/changelog.py b/scripts/changelog.py
@@ -10,16 +10,17 @@
 from scriv.create import create
 from scriv.scriv import Scriv
 
-from mitol.build_support.apps import App, list_apps
-from mitol.build_support.contextlib import chdir
-from mitol.build_support.decorators import app_option, pass_app, pass_project
-from mitol.build_support.project import Project
+from scripts.apps import App, list_apps
+from scripts.contextlibs import chdir
+from scripts.decorators import app_option, pass_app, pass_project
+from scripts.project import Project
 
 
 @group("changelog")
 @pass_context
-def changelog(ctx):  # noqa: ARG001
+def changelog(ctx):
     """Manage application changelogs"""
+    ctx.ensure_object(Project)
 
     makedirs("changelog.d", exist_ok=True)  # noqa: PTH103
 
@@ -49,12 +50,22 @@ def _echo_change(change: Diff):
     """Echo the change to stdout"""
     line = [change.change_type, change.a_path]
 
-    if change.renamed:
+    if change.renamed_file:
         line.extend(["->", changelog.b_path])
 
     echo(indent(" ".join(line), "\t"))
 
 
+def _is_source_excluded(path) -> bool:
+    excluded_paths = ["*/changelog.d/*", "*/CHANGELOG.md"]
+    return any([fnmatch(path, exclude) for exclude in excluded_paths])  # noqa: C419
+
+
+def _is_changelog_excluded(path) -> bool:
+    excluded_paths = ["*/scriv.ini"]
+    return any([fnmatch(path, exclude) for exclude in excluded_paths])  # noqa: C419
+
+
 @changelog.command()
 @option(
     "-b",
@@ -71,7 +82,7 @@ def _echo_change(change: Diff):
 @simple_verbosity_option()
 @pass_project
 @pass_context
-def check(ctx: Context, project: Project, base: str, target: str):  # noqa: C901
+def check(ctx: Context, project: Project, base: str, target: str):
     """Check for missing changelogs"""
     base_commit = project.repo.commit(base)
     target_commit = project.repo.commit(target)
@@ -81,38 +92,24 @@ def check(ctx: Context, project: Project, base: str, target: str):  # noqa: C901
     for app_abs_path in list_apps():
         app_rel_path = app_abs_path.relative_to(project.path)
 
-        excluded_paths = [app_rel_path / "changelog.d/*", app_rel_path / "CHANGELOG.md"]
-
-        def _is_excluded(path):
-            return any([fnmatch(path, exclude) for exclude in excluded_paths])  # noqa: B023, C419
-
         source_changes = [
             change
             for change in base_commit.diff(target_commit, paths=[app_rel_path])
-            if not _is_excluded(change.a_path) and not _is_excluded(change.b_path)
+            if not _is_source_excluded(change.a_path)
+            and not _is_source_excluded(change.b_path)
         ]
         has_source_changes = len(source_changes) > 0
 
-        changelogd_changes = base_commit.diff(
-            target_commit, paths=[app_rel_path / "changelog.d"]
-        )
+        changelogd_changes = [
+            change
+            for change in base_commit.diff(
+                target_commit, paths=[app_rel_path / "changelog.d"]
+            )
+            if not _is_changelog_excluded(change.a_path)
+            and not _is_changelog_excluded(change.b_path)
+        ]
         has_changelogd_changes = len(changelogd_changes) > 0
 
-        # If there's changes to the base requirements.txt, then we need to allow for
-        # changelogs to exist without the app code changing. There won't necessarily be
-        # changes in the individual apps if we're just updating project-wide dependencies.  # noqa: E501
-        # So, if there's no source changes, check if there's been changes to the
-        # requirements, and treat that as source changes.
-
-        if not has_source_changes:
-            reqs_paths = [
-                "build-support/requirements/requirements-testing.txt",
-                "build-support/requirements/requirements.txt",
-            ]
-
-            reqs_changes = base_commit.diff(target_commit, paths=reqs_paths)
-            has_source_changes = len(reqs_changes) > 0
-
         if has_source_changes and not has_changelogd_changes:
             echo(f"Changelog(s) are missing in {app_rel_path} for these changes:")
             for change in source_changes:
@@ -146,3 +143,7 @@ def _is_excluded(path):
 
     if is_error:
         ctx.exit(1)
+
+
+if __name__ == "__main__":
+    changelog()
diff --git a/scripts/contextlibs.py b/scripts/contextlibs.py
diff --git a/scripts/decorators.py b/scripts/decorators.py
@@ -3,8 +3,8 @@
 from click import Choice, Command, make_pass_decorator, option
 from cloup import Context, pass_context
 
-from mitol.build_support.apps import App, list_app_names
-from mitol.build_support.project import Project
+from scripts.apps import App, list_app_names
+from scripts.project import Project
 
 pass_project = make_pass_decorator(Project)
 pass_app = make_pass_decorator(App)
diff --git a/scripts/mitol/__init__.py b/scripts/mitol/__init__.py
diff --git a/scripts/mitol/build_support/__init__.py b/scripts/mitol/build_support/__init__.py
diff --git a/scripts/project.py b/scripts/project.py
diff --git a/scripts/release.py b/scripts/release.py
@@ -1,20 +1,21 @@
 from click import echo, pass_context
 from cloup import Context, group, option
 
-from mitol.build_support.apps import App
-from mitol.build_support.commands import changelog, version
-from mitol.build_support.decorators import (
+from scripts import changelog, version
+from scripts.apps import App
+from scripts.decorators import (
     app_option,
     no_require_main,
     pass_app,
     pass_project,
 )
-from mitol.build_support.project import Project
+from scripts.project import Project
 
 
 @group()
-def release():
-    pass
+@pass_context
+def release(ctx: Context):
+    ctx.ensure_object(Project)
 
 
 @release.command()
@@ -88,3 +89,7 @@ def push_to_remote(project: Project, app: App):
         [app.version_git_tag, "HEAD"],
         follow_tags=True,
     )
+
+
+if __name__ == "__main__":
+    release()
diff --git a/scripts/scriv/entry_title.md.j2 b/scripts/scriv/entry_title.md.j2
diff --git a/scripts/version.py b/scripts/version.py
@@ -0,0 +1,24 @@
+from bumpver import cli
+from cloup import Context, group, pass_context
+
+from scripts.decorators import app_option
+from scripts.project import Project
+
+
+@group()
+@pass_context
+def version(ctx: Context):
+    """CLI for build tools"""
+    ctx.ensure_object(Project)
+    ctx.invoke(cli.cli, **ctx.params)
+
+
+version.add_command(app_option(cli.grep))
+version.add_command(app_option(cli.init))
+version.add_command(app_option(cli.show))
+version.add_command(cli.test)  # this doesn't require config so doesn't require --app
+version.add_command(app_option(cli.update))
+
+
+if __name__ == "__main__":
+    version()
diff --git a/src/authentication/changelog.d/scriv.ini b/src/authentication/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/common/changelog.d/scriv.ini b/src/common/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/digitalcredentials/changelog.d/scriv.ini b/src/digitalcredentials/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/geoip/changelog.d/scriv.ini b/src/geoip/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/google_sheets/changelog.d/scriv.ini b/src/google_sheets/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/google_sheets_deferrals/changelog.d/scriv.ini b/src/google_sheets_deferrals/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/google_sheets_refunds/changelog.d/scriv.ini b/src/google_sheets_refunds/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/hubspot_api/changelog.d/scriv.ini b/src/hubspot_api/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/mail/changelog.d/scriv.ini b/src/mail/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/oauth_toolkit_extensions/changelog.d/scriv.ini b/src/oauth_toolkit_extensions/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/olposthog/changelog.d/scriv.ini b/src/olposthog/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/openedx/changelog.d/scriv.ini b/src/openedx/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/payment_gateway/changelog.d/scriv.ini b/src/payment_gateway/changelog.d/scriv.ini
@@ -1,5 +1,5 @@
 [scriv]
 format = md
 md_header_level = 2
-entry_title_template = file: ../../build-support/scriv/entry_title.${config:format}.j2
+entry_title_template = file: ../../scripts/scriv/entry_title.${config:format}.j2
 version = literal: __init__.py: __version__
diff --git a/src/uvtestapp/changelog.d/scriv.ini b/src/uvtestapp/changelog.d/scriv.ini
diff --git a/uv.lock b/uv.lock
