fogies 0.0.0.dev10__tar.gz → 0.0.0.dev12__tar.gz

{fogies-0.0.0.dev10 → fogies-0.0.0.dev12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fogies
-Version: 0.0.0.dev10
+Version: 0.0.0.dev12
 Summary: 
 Author: James Fogarty
 Author-email: jayfo@users.noreply.github.com
@@ -12,6 +12,7 @@ Requires-Dist: filelock (>=3.25.2,<4.0.0)
 Requires-Dist: ollama (>=0.6.2,<0.7.0)
 Requires-Dist: psutil (>=7.2.2,<8.0.0)
 Requires-Dist: pydantic (>=2.12.5,<3.0.0)
+Requires-Dist: pyrage (>=1.4.0,<2.0.0)
 Requires-Dist: requests (>=2.33.0,<2.34.0)
 Requires-Dist: tenacity (>=9.1.4,<10.0.0)
 Requires-Dist: tomlkit (>=0.15.1,<0.16.0)

{fogies-0.0.0.dev10 → fogies-0.0.0.dev12}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "fogies"
 # Version follows semantic versioning <https://semver.org/>.
-version = "0.0.0-dev.10"
+version = "0.0.0-dev.12"
 description = ""
 authors = [
     {name = "James Fogarty",email = "jayfo@users.noreply.github.com"}
@@ -18,6 +18,7 @@ include = [
     {path = "src/fogies/includes/templates/aws.toml.template", format = ["sdist", "wheel"]},
     {path = "src/fogies/includes/templates/poetry.toml.template", format = ["sdist", "wheel"]},
     {path = "src/fogies/includes/templates/backend_status.toml.template", format = ["sdist", "wheel"]},
+    {path = "src/fogies/includes/templates/claude_sync.toml.template", format = ["sdist", "wheel"]},
 ]
 
 [tool.poetry.dependencies]
@@ -33,6 +34,7 @@ pydantic = "^2.12.5"
 requests = "~2.33.0"
 tenacity = "^9.1.4"
 tomlkit = "^0.15.1"
+pyrage = "^1.4.0"
 
 [tool.poetry.group.dev.dependencies]
 # ^ allows all minor and patch releases.

fogies-0.0.0.dev12/src/fogies/age_key.py

@@ -0,0 +1,48 @@
+"""Age secret keys, which encrypt what claude-sync uploads.
+
+An age secret key is a string like AGE-SECRET-KEY-1...: see
+<https://github.com/FiloSottile/age>. pyrage, which binds to a Rust
+implementation of age, creates and checks them. It ships no type stubs, so the
+little of it that is used is given types here and nowhere else.
+"""
+
+from typing import Protocol, cast
+
+import pyrage  # pyright: ignore[reportMissingTypeStubs]
+
+
+class _IdentityFactory(Protocol):
+    """The parts of pyrage's x25519 Identity class that are used."""
+
+    def generate(self) -> object: ...
+
+    def from_str(self, value: str) -> object: ...
+
+
+_IDENTITY = cast(
+    _IdentityFactory,
+    pyrage.x25519.Identity,  # pyright: ignore[reportUnknownMemberType, reportAttributeAccessIssue]
+)
+
+_IDENTITY_ERROR = cast(
+    type[Exception],
+    pyrage.IdentityError,  # pyright: ignore[reportAttributeAccessIssue]
+)
+
+
+def generate_age_key() -> str:
+    """Return a new, random age secret key."""
+    return str(_IDENTITY.generate())
+
+
+def validate_age_key(value: str) -> str:
+    """Return value, if it is an age secret key.
+
+    Raises ValueError if it is not, including a key with a mistyped character,
+    since the checksum is checked.
+    """
+    try:
+        _ = _IDENTITY.from_str(value)
+    except _IDENTITY_ERROR as exc:
+        raise ValueError("Not an age secret key") from exc
+    return value

fogies-0.0.0.dev12/src/fogies/includes/templates/claude_sync.toml.template

@@ -0,0 +1,16 @@
+# Config for claude-sync tasks.
+# See https://github.com/tawanorg/claude-sync
+
+# Profile in the AWS config, for an IAM user that can use the bucket.
+aws_profile = "..."
+
+# S3 bucket.
+bucket = "..."
+region = "..."
+
+# What to sync: "sessions" or "full".
+scope = "sessions"
+
+# Encryption key.
+# claude-sync.configure will create, so that all machines have the same key.
+# age_key = "AGE-SECRET-KEY-1..."

{fogies-0.0.0.dev10 → fogies-0.0.0.dev12}/src/fogies/tasks/access_key.py

@@ -98,6 +98,7 @@ def get_task_create(
 ) -> Task[Callable[..., None]]:
     @task(
         name="create",
+        auto_shortflags=False,
         positional=[],
         help={
             "prompt": "Prompt for admin credentials.",
@@ -125,6 +126,7 @@ def get_task_delete(
 ) -> Task[Callable[..., None]]:
     @task(
         name="delete",
+        auto_shortflags=False,
         positional=[],
         help={
             "prompt": "Prompt for admin credentials.",
@@ -159,6 +161,7 @@ def get_task_delete_key(
 ) -> Task[Callable[..., None]]:
     @task(
         name="delete-key",
+        auto_shortflags=False,
         positional=[],
         help={
             "prompt": "Prompt for admin credentials.",
@@ -206,6 +209,7 @@ def get_task_list(
 ) -> Task[Callable[..., None]]:
     @task(
         name="list",
+        auto_shortflags=False,
         help={
             "prompt": "Prompt for admin credentials.",
         },
@@ -235,6 +239,7 @@ def get_task_rotate_key(
 ) -> Task[Callable[..., None]]:
     @task(
         name="rotate-key",
+        auto_shortflags=False,
         positional=[],
         help={
             "prompt": "Prompt for admin credentials.",

fogies-0.0.0.dev12/src/fogies/tasks/claude_sync.py

@@ -0,0 +1,145 @@
+"""Tasks for setting up and running claude-sync."""
+
+import pathlib
+from collections.abc import Callable
+from typing import cast
+
+from invoke.collection import Collection
+from invoke.context import Context
+from invoke.tasks import Task, task
+
+from fogies.tools.claude_sync import claude_sync, configure_claude_sync
+from fogies.tools.command import CommandParams
+
+
+def get_task_configure(
+    *,
+    binary_cache_path: pathlib.Path,
+    claude_sync_config_path: pathlib.Path,
+    aws_config_path: pathlib.Path,
+) -> Task[Callable[..., None]]:
+    @task(
+        name="configure",
+        auto_shortflags=False,
+        help={
+            "force": "Force overwrite based on current configuration.",
+        },
+    )  # pyright: ignore[reportUntypedFunctionDecorator]
+    def task_configure(context: Context, force: bool = False) -> None:
+        """
+        Configure claude-sync on this machine.
+        """
+        setup = configure_claude_sync(
+            claude_sync_config_path=claude_sync_config_path,
+            aws_config_path=aws_config_path,
+            force=force,
+        )
+
+        if setup.generated_age_key:
+            print("Generated encryption key.")
+        if setup.applied_to_claude_sync_files:
+            print("Applied configuration to claude-sync files.")
+        else:
+            print("Already configured.")
+
+        # Reads from the bucket and changes nothing, so this fails now, and
+        # clearly, if the credentials, bucket or key are wrong.
+        print("Checking the connection:")
+        with claude_sync(
+            binary_cache_path=binary_cache_path, raise_if_env_exists=False
+        ) as cs:
+            _ = cs.pull(command_params=CommandParams(context=context), dry_run=True)
+
+    return cast(Task[Callable[..., None]], task_configure)
+
+
+def get_task_pull(
+    *,
+    binary_cache_path: pathlib.Path,
+    default_dry_run: bool = False,
+    default_force: bool = False,
+    default_rebuild_history: bool = True,
+) -> Task[Callable[..., None]]:
+    @task(
+        name="pull",
+        auto_shortflags=False,
+        help={
+            "dry_run": "Show what would be downloaded.",
+            "force": "Force overwrite of local files.",
+            "rebuild_history": "Rebuild history from session files.",
+        },
+    )  # pyright: ignore[reportUntypedFunctionDecorator]
+    def task_pull(
+        context: Context,
+        dry_run: bool = default_dry_run,
+        force: bool = default_force,
+        rebuild_history: bool = default_rebuild_history,
+    ) -> None:
+        """
+        Download remote changes.
+        """
+        with claude_sync(
+            binary_cache_path=binary_cache_path, raise_if_env_exists=False
+        ) as cs:
+            _ = cs.pull(
+                command_params=CommandParams(context=context),
+                dry_run=dry_run,
+                force=force,
+                rebuild_history=rebuild_history,
+            )
+
+    return cast(Task[Callable[..., None]], task_pull)
+
+
+def get_task_push(*, binary_cache_path: pathlib.Path) -> Task[Callable[..., None]]:
+    @task(
+        name="push", auto_shortflags=False
+    )  # pyright: ignore[reportUntypedFunctionDecorator]
+    def task_push(context: Context) -> None:
+        """
+        Upload local changes.
+        """
+        with claude_sync(
+            binary_cache_path=binary_cache_path, raise_if_env_exists=False
+        ) as cs:
+            _ = cs.push(command_params=CommandParams(context=context))
+
+    return cast(Task[Callable[..., None]], task_push)
+
+
+def get_task_status(*, binary_cache_path: pathlib.Path) -> Task[Callable[..., None]]:
+    @task(
+        name="status", auto_shortflags=False
+    )  # pyright: ignore[reportUntypedFunctionDecorator]
+    def task_status(context: Context) -> None:
+        """
+        Show local changes since prior synchronization.
+        """
+        with claude_sync(
+            binary_cache_path=binary_cache_path, raise_if_env_exists=False
+        ) as cs:
+            _ = cs.status(command_params=CommandParams(context=context))
+
+    return cast(Task[Callable[..., None]], task_status)
+
+
+def get_collection(
+    *,
+    collection_name: str,
+    binary_cache_path: pathlib.Path,
+    claude_sync_config_path: pathlib.Path,
+    aws_config_path: pathlib.Path,
+) -> Collection:
+    """Get a collection of tasks for setting up and running claude-sync."""
+    collection = Collection(collection_name)
+    collection.add_task(
+        get_task_configure(
+            binary_cache_path=binary_cache_path,
+            claude_sync_config_path=claude_sync_config_path,
+            aws_config_path=aws_config_path,
+        )
+    )
+    collection.add_task(get_task_pull(binary_cache_path=binary_cache_path))
+    collection.add_task(get_task_push(binary_cache_path=binary_cache_path))
+    collection.add_task(get_task_status(binary_cache_path=binary_cache_path))
+    return collection

{fogies-0.0.0.dev10 → fogies-0.0.0.dev12}/src/fogies/tasks/format.py

@@ -26,7 +26,9 @@ def get_task_format(
     if not (fmt_black or fmt_isort or fmt_terraform):
         raise ValueError("At least one fmt flag must be set.")
 
-    @task(name="format")  # pyright: ignore[reportUntypedFunctionDecorator]
+    @task(
+        name="format", auto_shortflags=False
+    )  # pyright: ignore[reportUntypedFunctionDecorator]
     def task_format(context: Context) -> None:
         """
         Apply code formatting.

{fogies-0.0.0.dev10 → fogies-0.0.0.dev12}/src/fogies/tasks/lint.py

@@ -9,7 +9,9 @@ from invoke.tasks import Task, task
 
 
 def get_task_lint() -> Task[Callable[[Context], None]]:
-    @task(name="lint")  # pyright: ignore[reportUntypedFunctionDecorator]
+    @task(
+        name="lint", auto_shortflags=False
+    )  # pyright: ignore[reportUntypedFunctionDecorator]
     def task_lint(context: Context) -> None:
         """
         Run linting.

{fogies-0.0.0.dev10 → fogies-0.0.0.dev12}/src/fogies/tasks/poetry.py

@@ -14,7 +14,9 @@ from fogies.templates import ensure_from_template, poetry_toml_template_factory
 
 
 def get_task_build() -> Task[Callable[[Context], None]]:
-    @task(name="build")  # pyright: ignore[reportUntypedFunctionDecorator]
+    @task(
+        name="build", auto_shortflags=False
+    )  # pyright: ignore[reportUntypedFunctionDecorator]
     def task_build(context: Context) -> None:
         """
         Build package artifacts.
@@ -33,7 +35,9 @@ def get_task_build() -> Task[Callable[[Context], None]]:
 
 
 def get_task_publish(*, secrets_poetry_path: Path) -> Task[Callable[[Context], None]]:
-    @task(name="publish")  # pyright: ignore[reportUntypedFunctionDecorator]
+    @task(
+        name="publish", auto_shortflags=False
+    )  # pyright: ignore[reportUntypedFunctionDecorator]
     def task_publish(context: Context) -> None:
         """
         Publish package to PyPI.

{fogies-0.0.0.dev10 → fogies-0.0.0.dev12}/src/fogies/tasks/terraform.py

@@ -21,62 +21,94 @@ from fogies.tools.terraform import (
 )
 
 
+def validate_init_params(*, init: bool, init_params: InitParams) -> None:
+    """Raise ValueError for task flags that cannot be given together.
+
+    The init options only apply when init runs, and Terraform does not allow
+    migrating state while also reconfiguring the backend.
+    """
+    if init_params.migrate_state and not init:
+        raise ValueError("--init-migrate-state requires --init")
+    if init_params.reconfigure and not init:
+        raise ValueError("--init-reconfigure requires --init")
+    if init_params.upgrade and not init:
+        raise ValueError("--init-upgrade requires --init")
+    if init_params.migrate_state and init_params.reconfigure:
+        raise ValueError(
+            "--init-migrate-state and --init-reconfigure cannot be combined"
+        )
+
+
 def get_task_apply(
     *,
     binary_cache_path: pathlib.Path,
     module_path: pathlib.Path,
     aws_environ_factory: AwsEnvironFactory | None = None,
-    backend: BackendConfig | None = None,
+    backend_config: BackendConfig | None = None,
     backend_status_path: pathlib.Path | None = None,
     tfbackend_factory: TfbackendFactory | None = None,
     tfvars_factory: TfvarsFactory | None = None,
     default_init: bool = True,
-    default_init_upgrade: bool = False,
+    default_init_migrate_state: bool = False,
     default_init_reconfigure: bool = False,
+    default_init_upgrade: bool = False,
     default_apply_auto_approve: bool = False,
-) -> Task[Callable[[Context, bool, bool, bool, bool], None]]:
-    if backend is not None and tfbackend_factory is None:
-        raise ValueError("tfbackend_factory is required when backend is set")
-    if (backend_status_path is None) != (backend is None):
-        raise ValueError("backend_status_path and backend must be provided together")
+) -> Task[Callable[[Context, bool, bool, bool, bool, bool], None]]:
+    if backend_config is not None and tfbackend_factory is None:
+        raise ValueError("tfbackend_factory is required when backend_config is set")
+    if (backend_config is not None or tfbackend_factory is not None) and (
+        aws_environ_factory is None
+    ):
+        raise ValueError(
+            "aws_environ_factory is required when backend_config or tfbackend_factory is set"
+        )
+    if (backend_status_path is None) != (backend_config is None):
+        raise ValueError(
+            "backend_status_path and backend_config must be provided together"
+        )
 
     @task(
         name="apply",
+        auto_shortflags=False,
         help={
             "init": "Include terraform init. Skip with --no-init.",
-            "init_upgrade": "During init, upgrade providers.",
+            "init_migrate_state": "During init, migrate state to a changed backend.",
             "init_reconfigure": "During init, reconfigure the backend.",
+            "init_upgrade": "During init, upgrade providers.",
             "apply_auto_approve": "Skip interactive confirmation.",
         },
     )  # pyright: ignore[reportUntypedFunctionDecorator]
     def task_apply(
         context: Context,
         init: bool = default_init,
-        init_upgrade: bool = default_init_upgrade,
+        init_migrate_state: bool = default_init_migrate_state,
         init_reconfigure: bool = default_init_reconfigure,
+        init_upgrade: bool = default_init_upgrade,
         apply_auto_approve: bool = default_apply_auto_approve,
     ) -> None:
         """
         Apply a Terraform configuration.
         """
-        if init_upgrade and not init:
-            raise ValueError("--init-upgrade requires --init")
-        if init_reconfigure and not init:
-            raise ValueError("--init-reconfigure requires --init")
+        init_params = InitParams(
+            migrate_state=init_migrate_state,
+            reconfigure=init_reconfigure,
+            upgrade=init_upgrade,
+        )
+        validate_init_params(init=init, init_params=init_params)
 
         command_params = CommandParams(context=context)
-        init_params = (
-            InitParams(upgrade=init_upgrade, reconfigure=init_reconfigure)
-            if init
-            else None
-        )
 
         with ExitStack() as stack:
-            if aws_environ_factory is not None:
-                _ = stack.enter_context(aws_environ_factory())
+            aws_environ = (
+                stack.enter_context(aws_environ_factory())
+                if aws_environ_factory
+                else None
+            )
 
             tfbackend_path = (
-                stack.enter_context(tfbackend_factory()) if tfbackend_factory else None
+                stack.enter_context(tfbackend_factory(aws_environ))
+                if tfbackend_factory and aws_environ
+                else None
             )
             tfvars_path = (
                 stack.enter_context(tfvars_factory()) if tfvars_factory else None
@@ -87,7 +119,8 @@ def get_task_apply(
                     binary_cache_path=binary_cache_path,
                     command_params=command_params,
                     module_path=module_path,
-                    backend=backend,
+                    backend_config=backend_config,
+                    aws_environ=aws_environ,
                     backend_status_path=backend_status_path,
                     tfbackend_path=tfbackend_path,
                     tfvars_path=tfvars_path,
@@ -99,7 +132,9 @@ def get_task_apply(
                 )
             )
 
-    return cast(Task[Callable[[Context, bool, bool, bool, bool], None]], task_apply)
+    return cast(
+        Task[Callable[[Context, bool, bool, bool, bool, bool], None]], task_apply
+    )
 
 
 def get_task_destroy(
@@ -107,57 +142,71 @@ def get_task_destroy(
     binary_cache_path: pathlib.Path,
     module_path: pathlib.Path,
     aws_environ_factory: AwsEnvironFactory | None = None,
-    backend: BackendConfig | None = None,
+    backend_config: BackendConfig | None = None,
     backend_status_path: pathlib.Path | None = None,
     tfbackend_factory: TfbackendFactory | None = None,
     tfvars_factory: TfvarsFactory | None = None,
     default_init: bool = True,
-    default_init_upgrade: bool = False,
+    default_init_migrate_state: bool = False,
     default_init_reconfigure: bool = False,
+    default_init_upgrade: bool = False,
     default_destroy_auto_approve: bool = False,
-) -> Task[Callable[[Context, bool, bool, bool, bool], None]]:
-    if backend is not None and tfbackend_factory is None:
-        raise ValueError("tfbackend_factory is required when backend is set")
-    if (backend_status_path is None) != (backend is None):
-        raise ValueError("backend_status_path and backend must be provided together")
+) -> Task[Callable[[Context, bool, bool, bool, bool, bool], None]]:
+    if backend_config is not None and tfbackend_factory is None:
+        raise ValueError("tfbackend_factory is required when backend_config is set")
+    if (backend_config is not None or tfbackend_factory is not None) and (
+        aws_environ_factory is None
+    ):
+        raise ValueError(
+            "aws_environ_factory is required when backend_config or tfbackend_factory is set"
+        )
+    if (backend_status_path is None) != (backend_config is None):
+        raise ValueError(
+            "backend_status_path and backend_config must be provided together"
+        )
 
     @task(
         name="destroy",
+        auto_shortflags=False,
         help={
             "init": "Include terraform init. Skip with --no-init.",
-            "init_upgrade": "During init, upgrade providers.",
+            "init_migrate_state": "During init, migrate state to a changed backend.",
             "init_reconfigure": "During init, reconfigure the backend.",
+            "init_upgrade": "During init, upgrade providers.",
             "destroy_auto_approve": "Skip interactive confirmation.",
         },
     )  # pyright: ignore[reportUntypedFunctionDecorator]
     def task_destroy(
         context: Context,
         init: bool = default_init,
-        init_upgrade: bool = default_init_upgrade,
+        init_migrate_state: bool = default_init_migrate_state,
         init_reconfigure: bool = default_init_reconfigure,
+        init_upgrade: bool = default_init_upgrade,
         destroy_auto_approve: bool = default_destroy_auto_approve,
     ) -> None:
         """
         Destroy a Terraform configuration.
         """
-        if init_upgrade and not init:
-            raise ValueError("--init-upgrade requires --init")
-        if init_reconfigure and not init:
-            raise ValueError("--init-reconfigure requires --init")
+        init_params = InitParams(
+            migrate_state=init_migrate_state,
+            reconfigure=init_reconfigure,
+            upgrade=init_upgrade,
+        )
+        validate_init_params(init=init, init_params=init_params)
 
         command_params = CommandParams(context=context)
-        init_params = (
-            InitParams(upgrade=init_upgrade, reconfigure=init_reconfigure)
-            if init
-            else None
-        )
 
         with ExitStack() as stack:
-            if aws_environ_factory is not None:
-                _ = stack.enter_context(aws_environ_factory())
+            aws_environ = (
+                stack.enter_context(aws_environ_factory())
+                if aws_environ_factory
+                else None
+            )
 
             tfbackend_path = (
-                stack.enter_context(tfbackend_factory()) if tfbackend_factory else None
+                stack.enter_context(tfbackend_factory(aws_environ))
+                if tfbackend_factory and aws_environ
+                else None
             )
             tfvars_path = (
                 stack.enter_context(tfvars_factory()) if tfvars_factory else None
@@ -168,7 +217,8 @@ def get_task_destroy(
                     binary_cache_path=binary_cache_path,
                     command_params=command_params,
                     module_path=module_path,
-                    backend=backend,
+                    backend_config=backend_config,
+                    aws_environ=aws_environ,
                     backend_status_path=backend_status_path,
                     tfbackend_path=tfbackend_path,
                     tfvars_path=tfvars_path,
@@ -179,7 +229,9 @@ def get_task_destroy(
                 )
             )
 
-    return cast(Task[Callable[[Context, bool, bool, bool, bool], None]], task_destroy)
+    return cast(
+        Task[Callable[[Context, bool, bool, bool, bool, bool], None]], task_destroy
+    )
 
 
 def get_collection(
@@ -188,7 +240,7 @@ def get_collection(
     binary_cache_path: pathlib.Path,
     module_path: pathlib.Path,
     aws_environ_factory: AwsEnvironFactory | None = None,
-    backend: BackendConfig | None = None,
+    backend_config: BackendConfig | None = None,
     backend_status_path: pathlib.Path | None = None,
     tfbackend_factory: TfbackendFactory | None = None,
     tfvars_factory: TfvarsFactory | None = None,
@@ -200,7 +252,7 @@ def get_collection(
             binary_cache_path=binary_cache_path,
             module_path=module_path,
             aws_environ_factory=aws_environ_factory,
-            backend=backend,
+            backend_config=backend_config,
             backend_status_path=backend_status_path,
             tfbackend_factory=tfbackend_factory,
             tfvars_factory=tfvars_factory,
@@ -211,7 +263,7 @@ def get_collection(
             binary_cache_path=binary_cache_path,
             module_path=module_path,
             aws_environ_factory=aws_environ_factory,
-            backend=backend,
+            backend_config=backend_config,
             backend_status_path=backend_status_path,
             tfbackend_factory=tfbackend_factory,
             tfvars_factory=tfvars_factory,