sobe 0.1__py3-none-any.whl

sobe/main.py

@@ -0,0 +1,153 @@
+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))

sobe-0.1.dist-info/METADATA

@@ -0,0 +1,93 @@
+Metadata-Version: 2.3
+Name: sobe
+Version: 0.1
+Summary: AWS-based drop box uploader
+Requires-Dist: boto3>=1.40.49
+Requires-Dist: platformdirs>=4.5.0
+Requires-Python: ==3.13.*
+Description-Content-Type: text/markdown
+
+# sobe
+
+A simple command-line tool for uploading files to an AWS S3 bucket that is publicly available through a CloudFront distribution. This is the traditional "drop box" use case that existed long before the advent of modern file sharing services.
+
+It will upload any files you give it to your bucket, in a current year subdirectory, because that's the only easy way to organize chaos.
+
+## Installation
+
+Use [uv](https://docs.astral.sh/uv/) to manage it.
+
+```bash
+uv tool install https://github.com/Liz4v/sobe.git
+```
+
+## Configuration
+
+On first run, `sobe` will create its config file as appropriate to the platform. You'll need to edit this file with your AWS bucket and CloudFront details:
+
+```toml
+# sobe configuration
+bucket = "your-bucket-name"
+url = "https://your-public-url/"
+cloudfront = "your-cloudfront-distribution-id"
+
+[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
+```
+
+## Usage
+
+```bash
+sobe [options] files...
+```
+
+### Options
+
+- `-y`, `--year`: Change the target year directory (default: current year)
+- `-i`, `--invalidate`: Invalidate CloudFront cache after upload
+- `-d`, `--delete`: Delete files instead of uploading
+- `-p`, `--policy`: Display required AWS IAM policy and exit
+
+### Examples
+
+Upload files to current year directory:
+```bash
+sobe file1.jpg file2.pdf
+```
+
+Upload files to a specific year:
+```bash
+sobe -y 2024 file1.jpg file2.pdf
+```
+
+Upload and invalidate CloudFront cache:
+```bash
+sobe -i file1.jpg
+```
+
+Delete files:
+```bash
+sobe -d file1.jpg
+```
+
+Get required AWS IAM policy:
+```bash
+sobe --policy
+```
+
+## AWS Permissions
+
+Use `sobe --policy` to generate the exact IAM policy required for your configuration. The tool needs permissions for:
+- S3: PutObject, GetObject, ListBucket, DeleteObject
+- CloudFront: CreateInvalidation, GetInvalidation
+
+## License
+
+See the [LICENSE](LICENSE) file for details.

sobe-0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+sobe/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sobe/main.py,sha256=3x3wsfo4l_rh7Nr-GEsL3jiqU8jTrYINkojzvKTB1eI,5232
+sobe-0.1.dist-info/WHEEL,sha256=ZbtZh9LqsQoZs-WmwRO6z-tavdkb5LzNxvrOv2F_OXE,78
+sobe-0.1.dist-info/entry_points.txt,sha256=a_cKExqUEzJ-t2MRWbxAHc8OavQIaL8a7JQ3obR2b-c,41
+sobe-0.1.dist-info/METADATA,sha256=pd-fXFiH_aB6x8dr-tav4oUE4vtgE4FSlQ-_1FJ0ZSw,2219
+sobe-0.1.dist-info/RECORD,,

sobe-0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.1
+Root-Is-Purelib: true
+Tag: py3-none-any

sobe-0.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+sobe = sobe.main:main
+