sobe 0.1__tar.gz → 0.2__tar.gz

{sobe-0.1 → sobe-0.2}/PKG-INFO

@@ -1,10 +1,27 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: sobe
-Version: 0.1
+Version: 0.2
 Summary: AWS-based drop box uploader
+Author: Liz Balbuena
+License-Expression: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: File Sharing
+Classifier: Topic :: Utilities
 Requires-Dist: boto3>=1.40.49
 Requires-Dist: platformdirs>=4.5.0
-Requires-Python: ==3.13.*
+Requires-Python: >=3.11
+Project-URL: Changelog, https://github.com/Liz4v/sobe/releases
+Project-URL: Documentation, https://github.com/Liz4v/sobe/blob/main/README.md
+Project-URL: Homepage, https://github.com/Liz4v/sobe
+Project-URL: Issues, https://github.com/Liz4v/sobe/issues
+Project-URL: Repository, https://github.com/Liz4v/sobe.git
 Description-Content-Type: text/markdown
 
 # sobe
@@ -18,7 +35,13 @@ It will upload any files you give it to your bucket, in a current year subdirect
 Use [uv](https://docs.astral.sh/uv/) to manage it.
 
 ```bash
-uv tool install https://github.com/Liz4v/sobe.git
+uv tool install sobe
+```
+
+If you have Python ≥ 3.11, you can also install it via pip:
+
+```bash
+pip install sobe
 ```
 
 ## Configuration

{sobe-0.1 → sobe-0.2}/README.md

@@ -9,7 +9,13 @@ It will upload any files you give it to your bucket, in a current year subdirect
 Use [uv](https://docs.astral.sh/uv/) to manage it.
 
 ```bash
-uv tool install https://github.com/Liz4v/sobe.git
+uv tool install sobe
+```
+
+If you have Python ≥ 3.11, you can also install it via pip:
+
+```bash
+pip install sobe
 ```
 
 ## Configuration

sobe-0.2/pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "sobe"
+version = "0.2"
+description = "AWS-based drop box uploader"
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Environment :: Console",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Communications :: File Sharing",
+  "Topic :: Utilities",
+]
+authors = [
+  {name = "Liz Balbuena"},
+]
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+  "boto3>=1.40.49",
+  "platformdirs>=4.5.0",
+]
+
+[project.scripts]
+sobe = "sobe.main:main"
+
+[project.urls]
+Homepage = "https://github.com/Liz4v/sobe"
+Documentation = "https://github.com/Liz4v/sobe/blob/main/README.md"
+Repository = "https://github.com/Liz4v/sobe.git"
+Issues = "https://github.com/Liz4v/sobe/issues"
+Changelog = "https://github.com/Liz4v/sobe/releases"
+
+[tool.ruff]
+line-length = 120
+
+[build-system]
+requires = ["uv_build"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+  "ruff>=0.14.0",
+]

sobe-0.2/src/sobe/aws.py

@@ -0,0 +1,72 @@
+import datetime
+import json
+import mimetypes
+import pathlib
+import time
+
+import boto3
+import botocore.exceptions
+
+from .config import AWSConfig
+
+
+class AWS:
+    def __init__(self, config: AWSConfig) -> None:
+        self.config = config
+        self._session = boto3.Session(**self.config.session)
+        self._s3_resource = self._session.resource("s3", **self.config.service)
+        self._bucket = self._s3_resource.Bucket(self.config.bucket)  # type: ignore[attr-defined]
+        self._cloudfront = self._session.client("cloudfront", **self.config.service)
+
+    def upload(self, year: str, local_path: pathlib.Path) -> None:
+        """Uploads a file."""
+        type_guess, _ = mimetypes.guess_type(local_path)
+        extra_args = {"ContentType": type_guess or "application/octet-stream"}
+        self._bucket.upload_file(str(local_path), f"{year}/{local_path.name}", ExtraArgs=extra_args)
+
+    def delete(self, year: str, remote_filename: str) -> bool:
+        """Delete a file, if it exists. Returns whether it did."""
+        obj = self._bucket.Object(f"{year}/{remote_filename}")
+        try:
+            obj.load()
+            obj.delete()
+            return True
+        except botocore.exceptions.ClientError as e:  # pragma: no cover - network edge
+            if e.response.get("Error", {}).get("Code") == "404":
+                return False
+            raise
+
+    def invalidate_cache(self):
+        """Create and wait for a full-path CloudFront invalidation. Iterates until completion."""
+        ref = datetime.datetime.now().astimezone().isoformat()
+        batch = {"Paths": {"Quantity": 1, "Items": ["/*"]}, "CallerReference": ref}
+        distribution = self.config.cloudfront
+        response = self._cloudfront.create_invalidation(DistributionId=distribution, InvalidationBatch=batch)
+        invalidation = response["Invalidation"]["Id"]
+        status = "Created"
+        while status != "Completed":  # pragma: no cover - polling side effect
+            yield status
+            time.sleep(3)
+            response = self._cloudfront.get_invalidation(DistributionId=distribution, Id=invalidation)
+            status = response["Invalidation"]["Status"]
+
+    def generate_needed_permissions(self) -> str:
+        """Return the minimal IAM policy statement required by the tool."""
+        try:
+            sts = self._session.client("sts", **self.config.service)
+            account_id = sts.get_caller_identity()["Account"]
+        except botocore.exceptions.ClientError:  # pragma: no cover - network edge
+            account_id = "YOUR_ACCOUNT_ID"
+
+        actions = """
+            s3:PutObject s3:GetObject s3:ListBucket s3:DeleteObject
+            cloudfront:CreateInvalidation cloudfront:GetInvalidation
+        """.split()
+        resources = [
+            f"arn:aws:s3:::{self.config.bucket}",
+            f"arn:aws:s3:::{self.config.bucket}/*",
+            f"arn:aws:cloudfront::{account_id}:distribution/{self.config.cloudfront}",
+        ]
+        statement = {"Effect": "Allow", "Action": actions, "Resource": resources}
+        policy = {"Version": "2012-10-17", "Statement": [statement]}
+        return json.dumps(policy, indent=2)

sobe-0.2/src/sobe/config.py

@@ -0,0 +1,73 @@
+import tomllib
+from typing import Any, NamedTuple, Self
+
+from platformdirs import PlatformDirs
+
+
+class AWSConfig(NamedTuple):
+    bucket: str
+    cloudfront: str
+    session: dict[str, Any]
+    service: dict[str, Any]
+
+    @classmethod
+    def from_dict(cls, raw: dict[str, Any]) -> Self:
+        return cls(
+            bucket=raw.get("bucket", "example-bucket"),
+            cloudfront=raw.get("cloudfront", "E1111111111111"),
+            session=raw.get("session", {}),
+            service=raw.get("service", {}),
+        )
+
+
+class Config(NamedTuple):
+    url: str
+    aws: AWSConfig
+
+    @classmethod
+    def from_dict(cls, raw: dict[str, Any]) -> Self:
+        return cls(
+            url=raw.get("url", "https://example.com/"),
+            aws=AWSConfig.from_dict(raw.get("aws", {})),
+        )
+
+
+DEFAULT_TEMPLATE = """
+# sobe configuration
+
+url = "https://example.com/"
+
+[aws]
+bucket = "example-bucket"
+cloudfront = "E1111111111111"
+
+[aws.session]
+# If you already have AWS CLI set up, don't fill keys here.
+# region_name = "..."
+# profile_name = "..."
+# aws_access_key_id = "..."
+# aws_secret_access_key = "..."
+
+[aws.service]
+verify = true
+"""
+
+
+def load_config() -> Config:
+    path = PlatformDirs("sobe", "balbuena.ca").user_config_path / "config.toml"
+    if path.exists():
+        with path.open("rb") as f:
+            payload = tomllib.load(f)
+            if payload.get("aws", {}).get("bucket", "example-bucket") != "example-bucket":
+                return Config.from_dict(payload)
+
+    # create default file and exit for user to customize
+    defaults = "\n".join(line.strip() for line in DEFAULT_TEMPLATE.lstrip().splitlines())
+    path.parent.mkdir(parents=True, exist_ok=True)
+    path.write_text(defaults)
+    print("Created config file at the path below. You must edit it before use.")
+    print(path)
+    raise SystemExit(1)
+
+
+CONFIG: Config = load_config()

sobe-0.2/src/sobe/main.py

@@ -0,0 +1,64 @@
+import argparse
+import datetime
+import functools
+import pathlib
+import sys
+import warnings
+
+import urllib3.exceptions
+
+from .aws import AWS
+from .config import CONFIG
+
+write = functools.partial(print, flush=True, end="")
+print = functools.partial(print, flush=True)  # type: ignore
+warnings.filterwarnings("ignore", category=urllib3.exceptions.InsecureRequestWarning)
+
+
+def main() -> None:
+    args = parse_args()
+    aws = AWS(CONFIG.aws)
+
+    for path in args.paths:
+        write(f"{CONFIG.url}{args.year}/{path.name} ...")
+        if args.delete:
+            existed = aws.delete(args.year, path.name)
+            print("deleted." if existed else "didn't exist.")
+        else:
+            aws.upload(args.year, path)
+            print("ok.")
+    if args.invalidate:
+        write("Clearing cache...")
+        for _ in aws.invalidate_cache():
+            write(".")
+        print("complete.")
+
+
+def parse_args() -> argparse.Namespace:
+    parser = argparse.ArgumentParser(description="Upload files to your AWS drop box.")
+    parser.add_argument("-y", "--year", type=int, default=datetime.date.today().year, help="change year directory")
+    parser.add_argument("-i", "--invalidate", action="store_true", help="invalidate CloudFront cache")
+    parser.add_argument("-d", "--delete", action="store_true", help="delete instead of upload")
+    parser.add_argument("--policy", action="store_true", help="generate IAM policy requirements and exit")
+    parser.add_argument("files", nargs="*", help="Source files.")
+    args = parser.parse_args()
+
+    if args.policy:
+        aws = AWS(CONFIG.aws)
+        print(aws.generate_needed_permissions())
+        sys.exit(0)
+
+    if not args.files and not args.invalidate:
+        parser.print_help()
+        sys.exit(0)
+
+    args.paths = [pathlib.Path(p) for p in args.files]
+    if not args.delete:
+        missing = [p for p in args.paths if not p.exists()]
+        if missing:
+            print("The following files do not exist:")
+            for p in missing:
+                print(f"  {p}")
+            sys.exit(1)
+
+    return args

sobe-0.1/pyproject.toml

@@ -1,25 +0,0 @@
-[project]
-name = "sobe"
-version = "0.1"
-description = "AWS-based drop box uploader"
-readme = "README.md"
-requires-python = "==3.13.*"
-dependencies = [
-    "boto3>=1.40.49",
-    "platformdirs>=4.5.0",
-]
-
-[project.scripts]
-sobe = "sobe.main:main"
-
-[tool.ruff]
-line-length = 120
-
-[build-system]
-requires = ["uv_build"]
-build-backend = "uv_build"
-
-[dependency-groups]
-dev = [
-    "ruff>=0.14.0",
-]

sobe-0.1/src/sobe/main.py

@@ -1,153 +0,0 @@
-import argparse
-import datetime
-import functools
-import json
-import mimetypes
-import pathlib
-import sys
-import time
-import tomllib
-import warnings
-
-import boto3
-import botocore.exceptions
-import platformdirs
-import urllib3.exceptions
-
-
-def load_config():
-    path = platformdirs.PlatformDirs("sobe", "balbuena.ca").user_config_path / "config.toml"
-    if path.exists():
-        with path.open("rb") as f:
-            payload = tomllib.load(f)
-            if payload["bucket"] != "example-bucket":
-                return payload
-
-    defaults = """
-        # sobe configuration
-        bucket = "example-bucket"
-        url = "https://example.com/"
-        cloudfront = "E1111111111111"
-
-        [aws_session]
-        # If you already have AWS CLI set up, don't fill keys here.
-        # region_name = "..."
-        # profile_name = "..."
-        # aws_access_key_id = "..."
-        # aws_secret_access_key = "..."
-
-        [aws_client]
-        verify = true
-    """
-    defaults = "\n".join(line.strip() for line in defaults.lstrip().splitlines())
-    path.parent.mkdir(parents=True, exist_ok=True)
-    path.write_text(defaults)
-    print("Created config file at the path below. You must edit it before use.")
-    print(path)
-    sys.exit(1)
-
-
-CONFIG = load_config()
-write = functools.partial(print, flush=True, end="")
-print = functools.partial(print, flush=True)  # type: ignore
-warnings.filterwarnings("ignore", category=urllib3.exceptions.InsecureRequestWarning)
-
-
-def main() -> None:
-    args = parse_args()
-    session = boto3.Session(**CONFIG["aws_session"])
-    bucket = session.resource("s3", **CONFIG["aws_client"]).Bucket(CONFIG["bucket"])
-    for path, key in zip(args.paths, args.keys):
-        if args.delete:
-            delete(bucket, key)
-        else:
-            upload(bucket, path, key)
-    if args.invalidate:
-        invalidate(session)
-
-
-def upload(bucket, path: pathlib.Path, remote_path: str) -> None:
-    write(f"{CONFIG['url']}{remote_path} ...")
-    type_guess, _ = mimetypes.guess_type(path)
-    extra_args = {"ContentType": type_guess or "application/octet-stream"}
-    bucket.upload_file(str(path), remote_path, ExtraArgs=extra_args)
-    print("ok.")
-
-
-def delete(bucket, remote_path: str) -> None:
-    write(f"{CONFIG['url']}{remote_path} ...")
-    obj = bucket.Object(remote_path)
-    try:
-        obj.load()
-        obj.delete()
-        print("deleted.")
-    except botocore.exceptions.ClientError as e:
-        if e.response["Error"]["Code"] != "404":
-            raise
-        print("didn't exist.")
-
-
-def invalidate(session: boto3.Session) -> None:
-    write("Clearing cache ...")
-    ref = datetime.datetime.now().astimezone().isoformat()
-    cloudfront = session.client("cloudfront", **CONFIG["aws_client"])
-    batch = {"Paths": {"Quantity": 1, "Items": ["/*"]}, "CallerReference": ref}
-    invalidation = cloudfront.create_invalidation(DistributionId=CONFIG["cloudfront"], InvalidationBatch=batch)
-    write("ok.")
-    invalidation_id = invalidation["Invalidation"]["Id"]
-    status = ""
-    while status != "Completed":
-        time.sleep(3)
-        write(".")
-        response = cloudfront.get_invalidation(DistributionId=CONFIG["cloudfront"], Id=invalidation_id)
-        status = response["Invalidation"]["Status"]
-    print("complete.")
-
-
-def parse_args() -> argparse.Namespace:
-    parser = argparse.ArgumentParser(description="Upload files to your AWS drop box.")
-    parser.add_argument("-y", "--year", type=int, default=datetime.date.today().year, help="change year directory")
-    parser.add_argument("-i", "--invalidate", action="store_true", help="invalidate CloudFront cache")
-    parser.add_argument("-d", "--delete", action="store_true", help="delete instead of upload")
-    parser.add_argument("--policy", action="store_true", help="display IAM policy requirements and exit")
-    parser.add_argument("files", nargs="*", help="Source files.")
-    args = parser.parse_args()
-
-    if args.policy:
-        dump_policy()
-        sys.exit(0)
-
-    if not args.files and not args.invalidate:
-        parser.print_help()
-        sys.exit(0)
-
-    args.paths = [pathlib.Path(p) for p in args.files]
-    args.keys = [f"{args.year}/{p.name}" for p in args.paths]
-    if not args.delete:
-        missing = [p for p in args.paths if not p.exists()]
-        if missing:
-            print("The following files do not exist:")
-            for p in missing:
-                print(f"  {p}")
-            sys.exit(1)
-
-    return args
-
-
-def dump_policy() -> None:
-    session = boto3.Session(**CONFIG["aws_session"])
-    sts = session.client("sts", **CONFIG["aws_client"])
-    caller = sts.get_caller_identity()["Arn"]
-    account_id = caller.split(":")[4]
-    actions = """
-        s3:PutObject s3:GetObject s3:ListBucket s3:DeleteObject
-        cloudfront:CreateInvalidation cloudfront:GetInvalidation
-    """.split()
-    resources = [
-        f"arn:aws:s3:::{CONFIG['bucket']}",
-        f"arn:aws:s3:::{CONFIG['bucket']}/*",
-        f"arn:aws:cloudfront::{account_id}:distribution/{CONFIG['cloudfront']}",
-    ]
-    statement = {"Effect": "Allow", "Action": actions, "Resource": resources}
-    policy = {"Version": "2012-10-17", "Statement": [statement]}
-    print(json.dumps(policy, indent=2))