Added improved release script

Signed-off-by: Nick Brook <[email protected]>

Author: nrbrook

.pre-commit-config.yaml

@@ -18,14 +18,19 @@ repos:
     rev: v1.15.0
     hooks:
     -   id: mypy
-        exclude: ^(examples)
+        exclude: ^(examples|scripts)
         args: [
             --config-file, pyproject.toml,
-
         ]
         additional_dependencies: [
             bleak==0.22.3,
             rich==13.9.4,
             packaging,
             prompt_toolkit>=3.0.0,
         ]
+
+-   repo: https://github.com/PyCQA/bandit
+    rev: '1.8.3'
+    hooks:
+    - id: bandit
+      args: [ -c, pyproject.toml, "-r", "."]

scripts/release.py

@@ -0,0 +1,198 @@
+#!/usr/bin/env python3
+"""Script to bump the version of the package.
+
+Usage: python scripts/bump_version.py [major|minor|patch]
+"""
+
+import argparse
+import re
+import subprocess
+import sys
+from datetime import datetime
+from pathlib import Path
+
+import tomli
+import tomli_w
+
+
+def update_pyproject_toml(new_version):
+    """Update the version in pyproject.toml."""
+    pyproject_path = Path(__file__).parent.parent / "pyproject.toml"
+    content = tomli.loads(pyproject_path.read_text())
+
+    # Update version in project section
+    if "project" in content:
+        content["project"]["version"] = new_version
+    else:
+        print("Could not find [project] section in pyproject.toml")
+        sys.exit(1)
+
+    pyproject_path.write_text(tomli_w.dumps(content))
+    print(f"Updated version in pyproject.toml to {new_version}")
+
+
+def update_init_py(new_version):
+    """Update the version in __init__.py."""
+    init_py_path = Path(__file__).parent.parent / "test-a-ble" / "__init__.py"
+    content = init_py_path.read_text()
+
+    # Replace the version
+    content = re.sub(
+        r'__version__ = "[0-9]+\.[0-9]+\.[0-9]+"',
+        f'__version__ = "{new_version}"',
+        content,
+    )
+
+    init_py_path.write_text(content)
+    print(f"Updated version in __init__.py to {new_version}")
+
+
+def update_docs_conf_py(new_version):
+    """Update the version in docs/source/conf.py."""
+    conf_py_path = Path(__file__).parent.parent / "docs" / "source" / "conf.py"
+    content = conf_py_path.read_text()
+
+    # Replace the version
+    content = re.sub(r"release = '[0-9]+\.[0-9]+\.[0-9]+'", f"release = '{new_version}'", content)
+
+    conf_py_path.write_text(content)
+    print(f"Updated version in docs/source/conf.py to {new_version}")
+
+
+def update_changelog(new_version):
+    """Update the changelog with a new version section."""
+    changelog_path = Path(__file__).parent.parent / "CHANGELOG.md"
+    content = changelog_path.read_text()
+
+    # Check if the new version already exists in the changelog
+    if f"## [{new_version}]" in content:
+        print(f"Version {new_version} already exists in CHANGELOG.md")
+        return
+
+    # Get the current date
+    today = datetime.now().strftime("%Y-%m-%d")
+
+    # Create a new version section
+    new_section = f"""## [{new_version}] - {today}
+
+### Added
+-
+
+### Changed
+-
+
+### Fixed
+-
+
+"""
+
+    # Insert the new section after the header
+    content = re.sub(
+        r"(## \[)",
+        f"{new_section}\n\n\1",
+        content,
+        flags=re.DOTALL,
+    )
+
+    changelog_path.write_text(content)
+    print(f"Updated CHANGELOG.md with new version {new_version}")
+
+
+def get_current_version():
+    """Get the current version from pyproject.toml."""
+    pyproject_path = Path(__file__).parent.parent / "pyproject.toml"
+    try:
+        content = tomli.loads(pyproject_path.read_text())
+        if "project" in content and "version" in content["project"]:
+            return content["project"]["version"]
+    except Exception as e:
+        print(f"Error reading pyproject.toml: {e}")
+        sys.exit(1)
+
+    print("Could not find version in pyproject.toml")
+    sys.exit(1)
+
+
+def bump_version(current_version, part):
+    """Bump the version according to the specified part."""
+    major, minor, patch = map(int, current_version.split("."))
+
+    if part == "major":
+        major += 1
+        minor = 0
+        patch = 0
+    elif part == "minor":
+        minor += 1
+        patch = 0
+    elif part == "patch":
+        patch += 1
+    else:
+        print(f"Invalid part: {part}")
+        sys.exit(1)
+
+    return f"{major}.{minor}.{patch}"
+
+
+def run_git_command(cmd, check=True):
+    """Run a git command safely."""
+    git_exe = "git"  # Could be made configurable if needed
+    try:
+        return subprocess.run([git_exe, *cmd], check=check, shell=False, text=True, capture_output=True)  # noqa: S603  # nosec: B603
+    except subprocess.CalledProcessError as e:
+        print(f"Git command failed: {e}")
+        sys.exit(1)
+
+
+def main():
+    """Execute the main function."""
+    parser = argparse.ArgumentParser(description="Bump the version of the package.")
+    parser.add_argument(
+        "part",
+        nargs="?",
+        choices=["major", "minor", "patch"],
+        help="The part of the version to bump (optional)",
+    )
+    args = parser.parse_args()
+
+    current_version = get_current_version()
+    if args.part:
+        new_version = bump_version(current_version, args.part)
+        print(f"Bumping version from {current_version} to {new_version}")
+
+        update_pyproject_toml(new_version)
+        update_init_py(new_version)
+        update_docs_conf_py(new_version)
+        update_changelog(new_version)
+
+        print(f"Version bumped to {new_version}")
+        print("Don't forget to commit the changes and create a new tag:")
+        print(f"git commit -am 'Bump version to {new_version}'")
+    else:
+        new_version = current_version
+        print("Commands to run to create a new tag:")
+
+    print(f"git tag -a v{new_version} -m 'Version {new_version}'")
+    print("git push && git push --tags")
+    print("\nDo you want to run the git commands now? (y/n)")
+    response = input().strip().lower()
+
+    if response in {"y", "yes"}:
+        print("Running git commands...")
+        if args.part:
+            run_git_command(["commit", "-am", f"Bump version to {new_version}"])
+        run_git_command(["tag", "-a", f"v{new_version}", "-m", f"Version {new_version}"])
+
+        print("Do you want to push the changes? (y/n)")
+        push_response = input().strip().lower()
+        if push_response in {"y", "yes"}:
+            run_git_command(["push"])
+            run_git_command(["push", "--tags"])
+            print("Changes pushed successfully.")
+        else:
+            print("Changes committed and tagged locally. Run 'git push && git push --tags' when ready.")
+    else:
+        print("Commands not executed. Run them manually when ready.")
+
+
+if __name__ == "__main__":
+    main()