package-scripts 0.2.3__py3-none-any.whl

package_scripts/build.py

@@ -0,0 +1,123 @@
+import shutil
+from pathlib import Path
+from typing import Annotated
+
+import twine.commands.upload
+from rich import print as rprint
+from twine.settings import Settings
+from typer import Option, Typer, prompt
+
+import build
+
+from .common import run
+
+cli = Typer(pretty_exceptions_enable=False)
+default_dist_path = Path.cwd() / "dist"
+
+
+def get_default_branch():
+    git_process = run("git config get --default main init.defaultbranch")
+
+    if git_process.returncode:
+        rprint(f"[bold red]Error while getting default git branch: {git_process.stderr}[/]")
+        raise SystemExit(git_process.returncode)
+
+    return git_process.stdout
+
+
+def get_current_branch():
+    git_process = run("git rev-parse --abbrev-ref HEAD")
+
+    if git_process.returncode:
+        rprint(f"[bold red]Error while getting current git branch: {git_process.stderr}[/]")
+        raise SystemExit(git_process.returncode)
+
+    return git_process.stdout
+
+
+def check_last_commit_for_tag():
+    git_process = run("git tag --points-at $(git rev-parse HEAD)")
+
+    if git_process.returncode:
+        rprint(f"[bold red]Error while getting last git log entry: {git_process.stderr}[/]")
+        raise SystemExit(git_process.returncode)
+
+    if not git_process.stdout:
+        return False
+
+    return True
+
+
+def build_python_package(dist_dir: Path):
+    if dist_dir.exists():
+        shutil.rmtree(dist_dir)
+    dist_dir.mkdir(parents=True, exist_ok=True)
+
+    builder = build.ProjectBuilder(Path.cwd())
+    builder.build("wheel", output_directory=str(dist_dir.absolute()))
+    builder.build("sdist", output_directory=str(dist_dir.absolute()))
+
+    dist_files = [str(p) for p in dist_dir.iterdir()]
+
+    return dist_files
+
+
+def publish(dist_files: list[str], prompt_for_token: bool = False):
+    default_branch = get_default_branch()
+    current_branch = get_current_branch()
+    if current_branch != default_branch:
+        rprint(f"[bold red]Cannot publish from a branch that is not {default_branch}.[/]")
+        raise SystemExit(1)
+
+    if not check_last_commit_for_tag():
+        rprint(
+            f"[bold red]Cannot publish with stale tags, "
+            f"last commit on {default_branch} does not contain any new tags.[/]"
+        )
+        raise SystemExit(1)
+
+    settings_kwargs = {"verbose": True, "non_interactive": True}
+    if prompt_for_token:
+        prompted_token = None
+        while prompted_token is None:
+            prompted_token = prompt("Enter PyPI token", hide_input=True, confirmation_prompt=True)
+        settings_kwargs.update(password=prompted_token, username="__token__")
+
+    twine.commands.upload.upload(
+        Settings(
+            **settings_kwargs,
+        ),
+        dist_files,
+    )
+
+
+@cli.command(help="Build and (optionally) publish a package to PyPI")
+def main(
+    dist_dir: Annotated[
+        Path, Option("--dist", help="Where the built packages should go", dir_okay=True, file_okay=False)
+    ] = default_dist_path,
+    publish_to_pypi: Annotated[
+        bool,
+        Option(
+            "--publish",
+            help=(
+                "Publish to PyPi "
+                "[dim]"
+                "(If --prompt-for-token is not provided, "
+                "you must authenticate with PyPI by some other means. "
+                "See Twine's [link=https://twine.readthedocs.io/en/latest/]documentation[/link] "
+                "for details)"
+                "[/]"
+            ),
+        ),
+    ] = False,
+    prompt_for_token: Annotated[bool, Option("--prompt-for-token", help="Prompt for PyPI token.")] = False,
+):
+    dist_files = build_python_package(dist_dir)
+    if publish_to_pypi:
+        publish(dist_files, prompt_for_token)
+
+
+if __name__ == "__main__":
+    ...
+    #cli()

package_scripts/common.py

@@ -0,0 +1,47 @@
+import subprocess
+from pathlib import Path
+
+from typer import BadParameter, CallbackParam, Context
+
+this_directory = Path(__file__).parent
+package_name = __name__.split(".")[0]
+
+
+def run(cmd):
+    """
+    Runs shell commands in the project's root directory
+
+    Args:
+        cmd (str):
+            The shell command that will be run
+
+    Returns:
+        subprocess.CompletedProcess
+    """
+
+    return subprocess.run(
+        cmd,
+        shell=True,
+        text=True,
+        cwd=Path.cwd(),
+        capture_output=True,
+        check=False,
+    )
+
+
+def create_mutually_exclusive_callback(size: int = 1):
+    """
+    From this GitHub issue comment: https://github.com/fastapi/typer/issues/140#issuecomment-898937671
+    """
+    group = set()
+
+    def callback(_: Context, param: CallbackParam, value: str):
+        # Add cli option to group if it was called with a value
+        if value is not None and param.name not in group:
+            group.add(param.name)
+        if len(group) > size - 1:
+            raise BadParameter(f"Option '{param.name}' is mutually exclusive with option '{group.pop()}'")
+
+        return value
+
+    return callback

package_scripts/deploy.py

@@ -0,0 +1,158 @@
+from os import getuid
+from pathlib import Path
+from pwd import getpwall
+from typing import Annotated
+
+from rich import print as rprint
+from rich.console import Console
+from rich.syntax import Syntax
+from typer import Option, Typer
+
+cli = Typer(pretty_exceptions_enable=False, no_args_is_help=True)
+
+
+create_user_cmd_template = """sudo useradd \\
+  --system \\
+  --shell /bin/bash \\
+  --home-dir {service_pwd} \\
+  {service_name}"""
+
+unit_file_template = """[Unit]
+Description="{service_name}"
+After=network.target
+
+[Service]
+Type=simple
+User={service_name}
+WorkingDirectory={service_pwd}
+ExecStart={service_exec}
+Restart=on-failure
+RestartSec=5
+
+Environment="{service_env_vars}"
+
+[Install]
+WantedBy=multi-user.target"""
+
+
+start_service_template = (
+    r"sudo systemctl daemon-reload && sudo systemctl enable {unit_file_name} && sudo systemctl start {unit_file_name}"
+)
+
+this_dir = Path(__file__).parent
+default_project_root = this_dir.parent if this_dir.parent.joinpath("pyproject.toml").exists() else Path().cwd()
+
+backslash = "[#fe885b]\\ [/#fe885b]"
+tab = "[white]  [/white]"  # It will collapse the spaces otherwise
+
+epilogue = f"""
+[#e0]Example:\n\n\n
+[dim]# An imaginary webapp called my-app[/dim] \n
+run-deploy {backslash} \n
+{tab}--service-name my-app {backslash} \n
+{tab}--working-directory /opt/my-app {backslash} \n
+{tab}--exec "my-app --port 80 --hostname '0.0.0.0'" {backslash} \n
+{tab}-v "PATH=/opt/my-app/venv" {backslash} \n
+{tab}-v "MY_APP_PORT=8080" {backslash} \n
+{tab}-v "MY_APP_CONFIG_FILE_PATH=/opt/my-app/config.yml"
+"""
+
+
+@cli.command(help="Generate and install a systemd unit file with the provided parameters", epilog=epilogue)
+def main(
+    service_name: Annotated[
+        str,
+        Option(
+            "--service-name",
+            help="The name of the service. (determines: systemd serivce name, unit file name, service account name)\n\n"
+            '[magenta dim]example: --service-name "my-app"[/]',
+        ),
+    ],
+    service_pwd: Annotated[
+        Path,
+        Option(
+            "--working-directory",
+            help="The working directory of the service's process\n\n"
+            '[magenta dim]example: --working-directory "/opt/my_app"[/]',
+            dir_okay=True,
+            file_okay=False,
+        ),
+    ],
+    service_exec: Annotated[
+        str,
+        Option(
+            "--exec",
+            help="The command and args that will be executed when the service is started. "
+            "Nested quotes must be escaped.\n\n"
+            "[magenta dim]example: --exec \"/opt/my_app/venv/bin/my_app --port 80 --host '0.0.0.0'\"[/]",
+        ),
+    ],
+    service_env_var: Annotated[
+        list[str],
+        Option(
+            "-v",
+            "--environment-variable",
+            help="Supply env vars to the service. Can be used multiple times. Values should resemble KEY=VALUE.\n\n"
+            "[magenta dim]example: "
+            '-v "MY_APP_CONFIG_FILE_PATH=/opt/my_app/config.yaml" '
+            '-v "MY_APP_PORT=8080"[/]',
+        ),
+    ] = (),
+    unit_file_path: Annotated[
+        Path,
+        Option(
+            "--unit-file-output-path",
+            help="The output path of the generated systemd unit file. "
+            "[dim]\\[default: /etc/systemd/system/{service-name}.service]",
+            exists=False,
+        ),
+    ] = None,
+    user_must_exist: Annotated[
+        bool,
+        Option(help="Check for the service account with the name {service-name} before creating the unit file\n\n"),
+    ] = True,
+    dry_run: Annotated[
+        bool,
+        Option("--dry-run", help="Don't generate a unit file, just print it to stdout"),
+    ] = False,
+):
+    if not dry_run and not unit_file_path and getuid() != 0:
+        rprint("[bold red]This script must be run as root[/]")
+        raise SystemExit(1)
+
+    if user_must_exist and service_name not in [pw.pw_name for pw in getpwall()]:
+        create_user_cmd = create_user_cmd_template.format(service_pwd=service_pwd, service_name=service_name)
+        rprint(
+            f"[bold red]The '{service_name}' service account has not been created yet.[/]\n"
+            f"Use the [dim cyan]--no-user-must-exist[/] option or run:[dim]\n{create_user_cmd}[/]\n"
+        )
+        if not dry_run:
+            raise SystemExit(1)
+
+    unit_file_content = unit_file_template.format(
+        service_name=service_name,
+        service_pwd=service_pwd.as_posix(),
+        service_exec=service_exec,
+        service_env_vars=" ".join(service_env_var),
+    )
+
+    if dry_run:
+        temp_file = Path("/tmp/{service_name}.service")
+        temp_file.write_text(unit_file_content)
+        console = Console()
+        syntax = Syntax.from_path(temp_file, theme="material", background_color="default")
+        console.print(syntax)
+        return
+
+    if not unit_file_path:
+        unit_file_path = Path(f"/etc/systemd/system/{service_name}.service")
+
+    unit_file_path.write_text(unit_file_content)
+    unit_file_path.chmod(mode=0o600)
+
+    start_service_cmd = start_service_template.format(unit_file_name=unit_file_path.name)
+    rprint(f"To enable the service run:\n[dim]{start_service_cmd}[/]")
+
+
+if __name__ == "__main__":
+    cli()

package_scripts/format.py

@@ -0,0 +1,50 @@
+from pathlib import Path
+from subprocess import CompletedProcess
+from typing import Annotated
+
+from rich import print as rprint
+from typer import Argument, Option, Typer
+
+from .common import run
+
+cli = Typer(pretty_exceptions_enable=False)
+
+
+@cli.command(help="Run isort, ruff format, and ruff check.")
+def main(
+    directories: Annotated[
+        list[Path], Argument(help="List of directories to format and lint", dir_okay=True, file_okay=False)
+    ] = (Path.cwd(),),
+    test_mode: Annotated[
+        bool, Option("--test-mode", help="Exits with error if formatter or linter encounter violations")
+    ] = False,
+):
+    dir_arg = " ".join(d.as_posix() for d in directories)
+
+    check_test_arg = format_test_arg = isort_test_arg = ""
+    if test_mode:
+        check_test_arg = "--exit-non-zero-on-fix"
+        format_test_arg = "--check --exit-non-zero-on-fix"
+        isort_test_arg = "--check"
+
+    messages = ""
+
+    isort_process: CompletedProcess = run(f"isort --atomic {isort_test_arg} {dir_arg}")
+    if isort_process.returncode:
+        messages += f"[bold yellow]isort:[/]\n{isort_process.stderr}\n"
+
+    check_process: CompletedProcess = run(f"ruff check --show-fixes --fix {check_test_arg} {dir_arg}")
+    if check_process.returncode:
+        messages += f"[bold yellow]ruff check:[/]\n{check_process.stdout}\n"
+
+    format_process: CompletedProcess = run(f"ruff format {format_test_arg} {dir_arg}")
+    if format_process.returncode:
+        messages += f"[bold yellow]ruff format:[/]\n{format_process.stdout}"
+
+    if messages:
+        rprint("[bold red]Formater / Linter errors:[/]\n\n" + messages)
+        raise SystemExit(1)
+
+
+if __name__ == "__main__":
+    cli()

package_scripts/test.py

@@ -0,0 +1,32 @@
+from pathlib import Path
+from typing import Annotated
+
+from rich import print as rprint
+from typer import Argument, Option, Typer
+
+from .common import run
+
+cli = Typer(pretty_exceptions_enable=False)
+
+
+@cli.command(help="Run pytest")
+def main(
+    file_or_dir: Annotated[
+        Path, Argument(help="Location of directory containing tests", dir_okay=True, file_okay=True)
+    ] = Path.cwd() / "tests",
+    from_last_failed: Annotated[
+        bool, Option("--from-last-failed", help="Exit on test failure and continue from last failing test next time")
+    ] = False,
+):
+    from_last_failed_arg = ""
+    if from_last_failed:
+        from_last_failed_arg = "--stepwise"
+    process = run(f"pytest {from_last_failed_arg} {file_or_dir.as_posix()}")
+
+    if process.returncode:
+        rprint("[bold red]pytest errors:[/]\n\n" + process.stderr.rstrip() + "\n")
+        raise SystemExit(process.returncode)
+
+
+if __name__ == "__main__":
+    cli()

package_scripts/version_bump.py

@@ -0,0 +1,136 @@
+import re
+from pathlib import Path
+from typing import Annotated
+
+from packaging.version import Version
+from rich import print as rprint
+from typer import Option, Typer
+
+from .common import create_mutually_exclusive_callback, run
+
+cli = Typer(pretty_exceptions_enable=False, no_args_is_help=True)
+
+pyproject_dot_toml = Path.cwd() / "pyproject.toml"
+mutually_exlclusive_callback = create_mutually_exclusive_callback(2)
+
+
+def get_current_version() -> Version:
+    content = pyproject_dot_toml.read_text()
+    match = re.search(r'^version\s*=\s*["\'](.+?)["\']', content, re.MULTILINE)
+    if not match:
+        print("Error: Version not found in pyproject.toml")
+        exit(1)
+    return Version(match.group(1))
+
+
+def get_new_version(version: Version, magnitude: str) -> str:
+    if magnitude == "dev":
+        dev_ver = version.dev + 1 if version.dev else 0
+        return f"{version.major}.{version.minor}.{version.micro}.dev{dev_ver}"
+
+    elif magnitude == "patch":
+        return f"{version.major}.{version.minor}.{version.micro + 1}"
+
+    elif magnitude == "minor":
+        return f"{version.major}.{version.minor + 1}.0"
+
+    elif magnitude == "major":
+        return f"{version.major + 1}.0.0"
+
+    else:
+        rprint(f"[bold red] Invalid version bump magnitude:[/] {magnitude}\nChoose one of: dev, patch, minor, major")
+        raise SystemExit(1)
+
+
+def set_new_version(new_version: str):
+    content = pyproject_dot_toml.read_text()
+    new_content = re.sub(
+        r'(^version\s*=\s*["\'])(.+?)(["\'])',
+        rf'version = "{new_version}"',
+        content,
+        flags=re.MULTILINE,
+    )
+    pyproject_dot_toml.write_text(new_content)
+
+
+def git_tag(version: str):
+    for cmd in [
+        run(f"git add {pyproject_dot_toml}"),
+        run(f'git commit -m "Release {version}"'),
+        run(f"git tag v{version}"),
+        run("git push"),
+        run(f"git push origin v{version}"),
+    ]:
+        if cmd.returncode:
+            cmd_message = cmd.stdout + cmd.stderr
+            rprint(f"[bold red]Error running git cmd '{cmd.args}':\n" + cmd_message)
+            raise SystemExit(cmd.returncode)
+
+
+@cli.command(help="Update pyproject.toml with a new version, pushing the new version as a git tag")
+def main(
+    dev: Annotated[
+        bool,
+        Option(
+            help="Bump dev version: Maj.Min.Pat.devDev → Maj.Min.Pat.dev{Dev+1}",
+            callback=mutually_exlclusive_callback,
+        ),
+    ] = None,
+    patch: Annotated[
+        bool,
+        Option(
+            help="Bump patch version: Maj.Min.Pat → Maj.Min.{Pat+1}",
+            callback=mutually_exlclusive_callback,
+        ),
+    ] = None,
+    minor: Annotated[
+        bool,
+        Option(
+            help="Bump minor version: Maj.Min.Pat → Maj.{Min+1}.0",
+            callback=mutually_exlclusive_callback,
+        ),
+    ] = None,
+    major: Annotated[
+        bool,
+        Option(
+            help="Bump major version: Maj.Min.Pat → {Maj+1}.0.0",
+            callback=mutually_exlclusive_callback,
+        ),
+    ] = None,
+    manual: Annotated[
+        bool,
+        Option(
+            help="You've modified pyproject.toml yourself. "
+            "Don't auto-increment based on release type. Only run git tag commands.",
+            callback=mutually_exlclusive_callback,
+        ),
+    ] = None,
+    dry_run: Annotated[
+        bool, Option(help="Only show log messages, do not modify version in any way", is_flag=True)
+    ] = False,
+) -> None:
+
+    if not pyproject_dot_toml.exists():
+        rprint(f"[bold red]Could not find [magenta]{pyproject_dot_toml.as_posix()}. Unable to set version.[/]")
+        raise SystemExit(1)
+
+    version_bump_magnitude = "dev" if dev else "patch" if patch else "minor" if minor else "major" if major else None
+
+    current_version = get_current_version()
+
+    if version_bump_magnitude is None:
+        print(current_version)
+        exit(0)
+
+    new_version = current_version
+    if not manual:
+        new_version = get_new_version(current_version, version_bump_magnitude)
+
+    rprint(f"[#fefefe]Bumping version:\n[#ababef]{current_version} [yellow]→ [blue]{new_version}[/]")
+    if not dry_run:
+        set_new_version(new_version)
+        git_tag(new_version)
+
+
+if __name__ == "__main__":
+    cli()

package_scripts-0.2.3.dist-info/METADATA

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: package-scripts
+Version: 0.2.3
+Author-email: Cam Ratchford <camratchford@gmail.com>
+Project-URL: Homepage, https://github.com/camratchford/package-scripts
+Project-URL: Source, https://github.com/camratchford/package-scripts
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer
+Requires-Dist: ruff
+Requires-Dist: isort
+Requires-Dist: pytest
+Requires-Dist: build
+Requires-Dist: setuptools
+Requires-Dist: packaging
+Requires-Dist: twine
+Dynamic: license-file
+
+# Miscelaneous Scripts
+
+Scripts for frequently performed Python development tasks.
+
+- run-build - Build and (optionally) publish a package to PyPI
+- run-deploy - Generate and install a systemd unit file with the provided parameters
+- run-test - Run pytest
+- run-format - Run isort, ruff format, and ruff check.
+- run-version-bump - Update pyproject.toml with a new version, pushing the new version's git tags
+

package_scripts-0.2.3.dist-info/RECORD

@@ -0,0 +1,13 @@
+package_scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+package_scripts/build.py,sha256=YuHBBivacn7qgcs7tf1fgcseQ3LsadjTCyLANuYtPJ0,3700
+package_scripts/common.py,sha256=odsZ9GVa0DPBEDe40lGY90lqMyeuAYlwYW7qVuIjnRE,1151
+package_scripts/deploy.py,sha256=q7ZDC1UMX9d5MlKBBUS220-LOXWePQrSMcaP8Kc2C0Y,5165
+package_scripts/format.py,sha256=7MHA84K7t4jL5jVdoucOG3hiuZpNFQhdd6FfPRhRsBE,1684
+package_scripts/test.py,sha256=x70bCk_cVtaiOBlRh4S_Ckk_Kz7JbhxSxiiRf3xigEM,943
+package_scripts/version_bump.py,sha256=yiGxAATGFD3nXPlKdR6kEPt8YLfsCBQcBd6WEPsV70E,4253
+package_scripts-0.2.3.dist-info/licenses/LICENSE,sha256=Rmn7wkN_w7iiZgvv4Q8Hy2jmiUq9E9iWYRp-iX75BBE,1073
+package_scripts-0.2.3.dist-info/METADATA,sha256=5VIiUJ4eN4pQQuUisu-K--IUaRiDYjlDEvGFmLG_yfs,1436
+package_scripts-0.2.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+package_scripts-0.2.3.dist-info/entry_points.txt,sha256=6zHpHx2WSmb8Ixa2qzaFbo2vr1V2CyY1aBBRJEaIg_Q,224
+package_scripts-0.2.3.dist-info/top_level.txt,sha256=0ggPCz4NVjRJNQv0llLG9GDXb_ErgLQOwbnvgGyE3vk,16
+package_scripts-0.2.3.dist-info/RECORD,,

package_scripts-0.2.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

package_scripts-0.2.3.dist-info/entry_points.txt

@@ -0,0 +1,6 @@
+[console_scripts]
+run-build = package_scripts.build:cli
+run-deploy = package_scripts.deploy:cli
+run-format = package_scripts.format:cli
+run-test = package_scripts.test:cli
+run-version-bump = package_scripts.version_bump:cli

package_scripts-0.2.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Cameron Ratchford
+
+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.

package_scripts-0.2.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+package_scripts