Package Updates and Documentation Improvements

Author: cpressland

.github/workflows/lint.yaml

@@ -13,8 +13,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
-      - run: pip install black ruff mypy types-requests
-      - run: ruff .
-      - run: black --check .
+          python-version: "3.13"
+      - run: pip install ruff mypy types-requests
+      - run: ruff check .
       - run: mypy .

.github/workflows/publish.yaml

@@ -13,7 +13,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
       - run: |
           pip install poetry
           poetry self add "poetry-dynamic-versioning[plugin]"

.github/workflows/retag.yaml

@@ -31,6 +31,6 @@ jobs:
     steps:
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
       - run: pip install container-tagbot
       - run: tagbot --username="${{ inputs.username }}" --password="${{ secrets.password }}" --source="${{ inputs.source }}" --tags="${{ inputs.tags }}"

.gitignore

@@ -106,8 +106,10 @@ ipython_config.py
 #pdm.lock
 #   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
 #   in version control.
-#   https://pdm.fming.dev/#use-with-ide
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
 .pdm.toml
+.pdm-python
+.pdm-build/
 
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
 __pypackages__/
@@ -165,8 +167,7 @@ cython_debug/
 .LSOverride
 
 # Icon must end with two \r
-Icon
-
+Icon
 
 # Thumbnails
 ._*

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Bink
+Copyright (c) 2024 Chris Pressland
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,11 +1,27 @@
 # Tagbot
 
-Tagbot retags OCI Container Images without needing a full Docker Pull / Docker Push workflow by working directly with the registry API.
+Tagbot is a tool for retagging OCI Container Images directly using the registry API, eliminating the need for a full Docker Pull/Push workflow.
+
+## Features
+
+- Add multiple tags to an image without pulling or pushing.
+- Efficient and API-driven.
 
 ## Usage
 
 ### Local Usage
 
+To use Tagbot locally, run:
+
+```shell
+tagbot \
+    --username <your-username> \
+    --password <your-password> \
+    --source <registry>/<image>:<tag> \
+    --tags <tag1>,<tag2>
+```
+
+#### Example:
 ```shell
 tagbot \
     --username example \
@@ -14,7 +30,11 @@ tagbot \
     --tags v1.0.0,1.0.0
 ```
 
-This would add an additional tag of `v1.0.0` to `example.azurecr.io/debian:latest`. The container image can then be pulled with either `example.azurecr.io/debian:latest`, `example.azurecr.io/debian:v1.0.0`, or `example.azurecr.io/debian:1.0.0`
+This command adds the tags `v1.0.0` and `1.0.0` to `example.azurecr.io/debian:latest`. The image can then be pulled using any of the following tags:
+
+- `example.azurecr.io/debian:latest`
+- `example.azurecr.io/debian:v1.0.0`
+- `example.azurecr.io/debian:1.0.0`
 
 ### GitHub Actions Usage
 
@@ -27,22 +47,34 @@ on:
 
 jobs:
   release:
-    uses: binkhq/tagbot/.github/workflows/retag.yaml@master
+    uses: cpressland/tagbot/.github/workflows/retag.yaml@master
     with:
       username: example
       source: example.azurecr.io/${{ github.event.repository.name }}:${{ github.ref_name }}
       tags: ${{ matrix.environment }}-v1.0.0,${{ matrix.environment }}
-      envirnment:  ${{ matrix.environment }}
+      environment:  ${{ matrix.environment }}
     secrets:
-      password: ${{ secrets.ACR_BINKCORE_PASSWORD }}
+      password: ${{ secrets.ACR_PASSWORD }}
     strategy:
       matrix:
         environment: [staging, production]
 ```
 
 ## FAQ
 
-* Whats going on with `ghcr.io/binkhq/tagbot`?
-  - This still exists, but is formally deprecated and will no longer recieve updates or support
-* Are Registries other than Azure Container Registry supported?
-  - Azure Container Registry is the only officially supported Registry, but other simple registries like Docker Hub are expected to work just fine.
+- **Q**: Are registries other than Azure Container Registry supported?<br>
+  **A**: Azure Container Registry is the only officially supported registry. However, other registries, such as Docker Hub, Amazon ECR, and Google Container Registry, are likely to work if they conform to standard OCI APIs.
+- **Q**: Does Tagbot require admin-level credentials for the registry?<br>
+  **A**: No, it only requires permissions to read and write tags for the specified images.
+- **Q**: Can I retag multiple images in a single command?<br>
+  **A**: No, Tagbot currently supports retagging one image at a time. Use a script or automation tool to process multiple images.
+- **Q**: Are there any size limitations for the images being retagged?<br>
+  **A**: No, since Tagbot operates at the registry level, the image size is irrelevant.
+- **Q**: Is Tagbot secure to use with my credentials?<br>
+  **A**: Tagbot does not store your credentials and only uses them for the duration of the operation. For additional security, use environment variables or secret management tools.
+- **Q**: Can I remove a tag from an image using Tagbot?<br>
+  **A**: No, Tagbot only supports adding new tags. To remove tags, use your registry's management tools.
+- **Q**: What happens if the specified tag already exists?<br>
+  **A**: If the tag already exists, Tagbot will reassign it to the source image.
+- **Q**: Is there a dry-run mode to test without making changes?<br>
+  **A**: Currently, Tagbot does not support a dry-run mode.

container_tagbot/__init__.py

@@ -11,15 +11,14 @@ def tagbot(username: str, password: str, source: str, new_tags: str) -> None:
     """Tag a container image in a registry.
 
     Args:
-    ----
         username (str): Username for Container Registry
         password (str): Password for Container Registry
         source (str): Source Container Image and Tag
         new_tags (str): New Container Image Tags, comma seperated
 
     Returns:
-    -------
         None
+
     """
     registry, image, tag = re.split("[:/]", source)