b2-cleanup 0.1.3__tar.gz → 0.1.4__tar.gz

b2_cleanup-0.1.4/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+---
+name: Publish to PyPI (Trusted Publisher)
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Build distribution
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish --trusted-publishing automatic
+

b2_cleanup-0.1.4/.gitignore

@@ -0,0 +1,30 @@
+# Python artifacts
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+
+# Logs
+*.log
+
+# Virtual environments
+.venv/
+env/
+venv/
+
+# Editor/IDE files
+.vscode/
+.idea/
+
+# OS artifacts
+.DS_Store
+Thumbs.db
+
+# Python packaging
+*.egg-info/
+
+# Coverage data
+.coverage
+htmlcov/
+coverage.xml
+

b2_cleanup-0.1.4/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.4] - 2025-05-09
+
+### Added
+- Comprehensive test suite with pytest
+- Code coverage reporting
+- Project restructured as a proper installable module
+- Added support for importing the tool as a library
+- Better error handling for missing B2 CLI
+- CLI entry point for easy command-line usage
+- Testing dependencies in dev extras
+
+### Fixed
+- Fixed attribute error when accessing UnfinishedLargeFile properties
+- Corrected TOML syntax in pyproject.toml (replaced // comments with #)
+- Proper packaging configuration with Hatchling
+
+### Changed
+- Split code into core.py and cli.py modules
+- Improved project structure for better maintainability
+- Enhanced logging with more descriptive messages
+
+## [0.1.3] - 2025-05-08
+
+### Added
+- Initial public release
+- Basic functionality to clean up unfinished large file uploads in B2 buckets
+- Support for authentication via CLI arguments, environment variables, or B2 CLI
+- Dry run mode to preview what would be deleted

{b2_cleanup-0.1.3 → b2_cleanup-0.1.4}/PKG-INFO

@@ -1,31 +1,41 @@
 Metadata-Version: 2.4
 Name: b2-cleanup
-Version: 0.1.3
+Version: 0.1.4
 Summary: CLI tool to clean up unfinished Backblaze B2 large uploads
-Author-email: Jeroen Verhoeven <jeroen@joentje.org>
-License: MIT
 Project-URL: Homepage, https://github.com/your-username/b2-cleanup
 Project-URL: Issues, https://github.com/your-username/b2-cleanup/issues
-Keywords: backblaze,b2,cli,cloud-storage,cleanup
+Project-URL: Changelog, https://github.com/your-username/b2-cleanup/blob/main/CHANGELOG.md
+Author-email: Jeroen Verhoeven <jeroen@joentje.org>
+License: MIT
+Keywords: b2,backblaze,cleanup,cli,cloud-storage
 Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Intended Audience :: Developers
 Classifier: Topic :: Utilities
 Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: click>=8.0
 Requires-Dist: b2sdk>=1.20.0
+Requires-Dist: click>=8.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.10.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# B2 Cleanup
 
-# b2-cleanup
+A CLI tool and Python library to clean up unfinished Backblaze B2 large file uploads.
 
-🧹 A Python CLI tool to clean up **unfinished large file uploads** in a [Backblaze B2](https://www.backblaze.com/b2/cloud-storage.html) bucket.
+[![PyPI version](https://badge.fury.io/py/b2-cleanup.svg)](https://badge.fury.io/py/b2-cleanup)
+[![Python Versions](https://img.shields.io/pypi/pyversions/b2-cleanup.svg)](https://pypi.org/project/b2-cleanup/)
 
-Built using [`b2sdk`](https://github.com/Backblaze/b2-sdk-python), [`click`](https://click.palletsprojects.com/), and [`uv`](https://github.com/astral-sh/uv) for performance and reproducibility.
+## 📋 Overview
+
+When uploading large files to Backblaze B2, interrupted uploads can leave behind unfinished file parts that consume storage and incur costs. This tool helps you identify and clean up these unfinished uploads.
 
 ---
 
@@ -42,25 +52,27 @@ Built using [`b2sdk`](https://github.com/Backblaze/b2-sdk-python), [`click`](htt
 
 ## 🚀 Installation
 
-### 1. Clone and create an isolated environment
-
 ```bash
-git clone https://github.com/<your-username>/b2-cleanup.git
-cd b2-cleanup
-
-uv venv
-source .venv/bin/activate
-uv pip install -e .
+pip install b2-cleanup
 ```
 
-> Requires [uv](https://github.com/astral-sh/uv) and Python 3.8+
-
 ---
 
 ## 🧪 Usage
 
 ```bash
-b2-cleanup BUCKET_NAME [OPTIONS]
+# Basic usage (requires B2 CLI to be installed and authorized)
+b2-cleanup your-bucket-name
+```
+
+```bash
+# Use with explicit credentials
+b2-cleanup your-bucket-name --key-id YOUR_KEY_ID --key YOUR_APPLICATION_KEY
+```
+
+```bash
+# Dry run to preview what would be deleted
+b2-cleanup your-bucket-name --dry-run
 ```
 
 ### Example (dry run):
@@ -81,6 +93,25 @@ b2-cleanup my-bucket --log-file cleanup_$(date +%F).log
 b2-cleanup my-bucket --key-id my-key-id --key my-app-key
 ```
 
+### Example (Python usage):
+
+```python
+from b2_cleanup import B2CleanupTool
+
+# Using environment variables or B2 CLI for auth
+tool = B2CleanupTool(dry_run=True)
+
+# Using explicit credentials
+tool = B2CleanupTool(
+    dry_run=False,
+    override_key_id="your-key-id",
+    override_key="your-application-key"
+)
+
+# Clean up unfinished uploads
+tool.cleanup_unfinished_uploads("your-bucket-name")
+```
+
 ---
 
 ## 🔐 Authentication
@@ -89,20 +120,21 @@ This tool supports three ways to authenticate with B2, in priority order:
 
 1. **Explicit CLI arguments**:
    ```bash
-   b2-cleanup my-bucket --key-id abc123 --key supersecretkey
+   b2-cleanup bucket-name --key-id YOUR_KEY_ID --key YOUR_APPLICATION_KEY
    ```
 
 2. **Environment variables**:
    ```bash
    export B2_APPLICATION_KEY_ID=abc123
    export B2_APPLICATION_KEY=supersecretkey
+   b2-cleanup bucket-name
    ```
 
 3. **The `b2` CLI** (must be previously authorized):
    ```bash
    b2 account authorize
    # Then the tool will read credentials via:
-   b2 account info
+   b2 account get
    ```
 
 ---
@@ -111,8 +143,16 @@ This tool supports three ways to authenticate with B2, in priority order:
 
 ```
 b2-cleanup/
-├── cleanup_unfinished_b2_uploads.py   # Core CLI logic (class-based)
-├── pyproject.toml                     # Project metadata + dependencies
+├── b2_cleanup/
+│   ├── __init__.py     # Package exports
+│   ├── core.py         # Core functionality 
+│   └── cli.py          # CLI implementation
+├── tests/
+│   ├── __init__.py
+│   ├── test_core.py
+│   └── test_cli.py
+├── pyproject.toml      # Project metadata + dependencies
+├── CHANGELOG.md        # Version history
 ├── .gitignore
 └── README.md
 ```
@@ -124,9 +164,23 @@ b2-cleanup/
 - The CLI entry point is `b2-cleanup` via `pyproject.toml`
 - Install in editable mode (`uv pip install -e .`) for fast development
 - Dependencies are managed via [`uv`](https://github.com/astral-sh/uv)
+- Testing dependencies: `uv pip install -e ".[dev]"`
 
 ---
 
+## 🧪 Testing
+
+```bash
+# Install dev dependencies
+pip install b2-cleanup[dev]
+
+# Run tests
+pytest
+
+# With coverage
+pytest --cov=b2_cleanup
+```
+
 ## 🛠️ Roadmap
 
 - [ ] Filter uploads by file age

b2_cleanup-0.1.4/README.md

@@ -0,0 +1,168 @@
+# B2 Cleanup
+
+A CLI tool and Python library to clean up unfinished Backblaze B2 large file uploads.
+
+[![PyPI version](https://badge.fury.io/py/b2-cleanup.svg)](https://badge.fury.io/py/b2-cleanup)
+[![Python Versions](https://img.shields.io/pypi/pyversions/b2-cleanup.svg)](https://pypi.org/project/b2-cleanup/)
+
+## 📋 Overview
+
+When uploading large files to Backblaze B2, interrupted uploads can leave behind unfinished file parts that consume storage and incur costs. This tool helps you identify and clean up these unfinished uploads.
+
+---
+
+## 🔧 Features
+
+- Lists all unfinished large file uploads in a given B2 bucket
+- Optionally cancels them (dry-run support included)
+- Uses the official `b2sdk` for native Backblaze API access
+- Supports authentication via env vars, CLI override, or the `b2` CLI
+- Clean CLI with logging support
+- Class-based and easily extensible
+
+---
+
+## 🚀 Installation
+
+```bash
+pip install b2-cleanup
+```
+
+---
+
+## 🧪 Usage
+
+```bash
+# Basic usage (requires B2 CLI to be installed and authorized)
+b2-cleanup your-bucket-name
+```
+
+```bash
+# Use with explicit credentials
+b2-cleanup your-bucket-name --key-id YOUR_KEY_ID --key YOUR_APPLICATION_KEY
+```
+
+```bash
+# Dry run to preview what would be deleted
+b2-cleanup your-bucket-name --dry-run
+```
+
+### Example (dry run):
+
+```bash
+b2-cleanup my-bucket --dry-run
+```
+
+### Example (delete for real, with logging):
+
+```bash
+b2-cleanup my-bucket --log-file cleanup_$(date +%F).log
+```
+
+### Example (override credentials):
+
+```bash
+b2-cleanup my-bucket --key-id my-key-id --key my-app-key
+```
+
+### Example (Python usage):
+
+```python
+from b2_cleanup import B2CleanupTool
+
+# Using environment variables or B2 CLI for auth
+tool = B2CleanupTool(dry_run=True)
+
+# Using explicit credentials
+tool = B2CleanupTool(
+    dry_run=False,
+    override_key_id="your-key-id",
+    override_key="your-application-key"
+)
+
+# Clean up unfinished uploads
+tool.cleanup_unfinished_uploads("your-bucket-name")
+```
+
+---
+
+## 🔐 Authentication
+
+This tool supports three ways to authenticate with B2, in priority order:
+
+1. **Explicit CLI arguments**:
+   ```bash
+   b2-cleanup bucket-name --key-id YOUR_KEY_ID --key YOUR_APPLICATION_KEY
+   ```
+
+2. **Environment variables**:
+   ```bash
+   export B2_APPLICATION_KEY_ID=abc123
+   export B2_APPLICATION_KEY=supersecretkey
+   b2-cleanup bucket-name
+   ```
+
+3. **The `b2` CLI** (must be previously authorized):
+   ```bash
+   b2 account authorize
+   # Then the tool will read credentials via:
+   b2 account get
+   ```
+
+---
+
+## 📁 Project Structure
+
+```
+b2-cleanup/
+├── b2_cleanup/
+│   ├── __init__.py     # Package exports
+│   ├── core.py         # Core functionality 
+│   └── cli.py          # CLI implementation
+├── tests/
+│   ├── __init__.py
+│   ├── test_core.py
+│   └── test_cli.py
+├── pyproject.toml      # Project metadata + dependencies
+├── CHANGELOG.md        # Version history
+├── .gitignore
+└── README.md
+```
+
+---
+
+## 📦 Packaging Notes
+
+- The CLI entry point is `b2-cleanup` via `pyproject.toml`
+- Install in editable mode (`uv pip install -e .`) for fast development
+- Dependencies are managed via [`uv`](https://github.com/astral-sh/uv)
+- Testing dependencies: `uv pip install -e ".[dev]"`
+
+---
+
+## 🧪 Testing
+
+```bash
+# Install dev dependencies
+pip install b2-cleanup[dev]
+
+# Run tests
+pytest
+
+# With coverage
+pytest --cov=b2_cleanup
+```
+
+## 🛠️ Roadmap
+
+- [ ] Filter uploads by file age
+- [ ] Support multiple buckets
+- [ ] Output metrics (count, size, cost saved)
+- [ ] Optional integration with S3-compatible B2 APIs
+
+---
+
+## 📝 License
+
+MIT License © 2025 Jeroen Verhoeven
+

b2_cleanup-0.1.4/b2_cleanup/__init__.py

@@ -0,0 +1,6 @@
+"""B2 Cleanup Tool - Clean up unfinished Backblaze B2 large uploads."""
+
+from .core import B2CleanupTool
+
+__version__ = "0.1.3"
+__all__ = ["B2CleanupTool"]

b2_cleanup-0.1.4/b2_cleanup/cli.py

@@ -0,0 +1,38 @@
+"""Command-line interface for B2 cleanup tool."""
+
+import logging
+import click
+from .core import B2CleanupTool
+
+
+@click.command()
+@click.argument("bucket")
+@click.option(
+    "--dry-run", is_flag=True, help="Only list unfinished uploads, do not cancel."
+)
+@click.option("--log-file", default="b2_cleanup.log", help="Path to log file.")
+@click.option("--key-id", help="Backblaze B2 applicationKeyId to override env/config.")
+@click.option("--key", help="Backblaze B2 applicationKey to override env/config.")
+def cli(bucket, dry_run, log_file, key_id, key):
+    """Clean up unfinished large file uploads in BUCKET."""
+    logger = logging.getLogger()
+    logger.setLevel(logging.INFO)
+    if logger.hasHandlers():
+        logger.handlers.clear()
+
+    file_handler = logging.FileHandler(log_file)
+    file_handler.setFormatter(
+        logging.Formatter("%(asctime)s [%(levelname)s] %(message)s")
+    )
+    logger.addHandler(file_handler)
+
+    stream_handler = logging.StreamHandler()
+    stream_handler.setFormatter(logging.Formatter("%(message)s"))
+    logger.addHandler(stream_handler)
+
+    tool = B2CleanupTool(dry_run=dry_run, override_key_id=key_id, override_key=key)
+    tool.cleanup_unfinished_uploads(bucket)
+
+
+if __name__ == "__main__":
+    cli()  # pragma: no cover

b2_cleanup-0.1.3/cleanup_unfinished_b2_uploads.py → b2_cleanup-0.1.4/b2_cleanup/core.py

@@ -1,18 +1,28 @@
+"""Core functionality for B2 cleanup tool."""
+
 import os
 import json
 import subprocess
 import logging
-import click
 from b2sdk.v2 import InMemoryAccountInfo, B2Api
 
 
 class B2CleanupTool:
+    """Tool to clean up unfinished large file uploads in B2 buckets."""
+
     def __init__(
         self,
         dry_run: bool = False,
         override_key_id: str = None,
         override_key: str = None,
     ):
+        """Initialize the B2 cleanup tool.
+
+        Args:
+            dry_run: If True, only list uploads but don't delete them
+            override_key_id: Optional B2 key ID to override env/config
+            override_key: Optional B2 application key to override env/config
+        """
         self.dry_run = dry_run
         self.logger = logging.getLogger("B2Cleanup")
         self.api = self._authorize(override_key_id, override_key)
@@ -36,12 +46,17 @@ class B2CleanupTool:
 
         try:
             self.logger.info("🔍 Trying to load credentials via `b2 account get`...")
-            result = subprocess.run(
-                ["b2", "account", "get"],
-                check=True,
-                capture_output=True,
-                text=True,
-            )
+            try:
+                result = subprocess.run(
+                    ["b2", "account", "get"],
+                    check=True,
+                    capture_output=True,
+                    text=True,
+                )
+            except FileNotFoundError:
+                self.logger.error("❌ Command 'b2' not found. Please install the B2 CLI or provide credentials.")
+                raise RuntimeError("B2 CLI not found. Please install it or provide credentials manually.")
+                
             creds = json.loads(result.stdout)
             key_id = creds["applicationKeyId"]
             app_key = creds["applicationKey"]
@@ -56,6 +71,11 @@ class B2CleanupTool:
             raise RuntimeError("Could not authorize with Backblaze B2.")
 
     def cleanup_unfinished_uploads(self, bucket_name: str):
+        """Find and clean up unfinished uploads in the specified bucket.
+
+        Args:
+            bucket_name: Name of the B2 bucket to clean up
+        """
         bucket = self.api.get_bucket_by_name(bucket_name)
         unfinished = list(bucket.list_unfinished_large_files())
         if not unfinished:
@@ -64,43 +84,11 @@ class B2CleanupTool:
 
         self.logger.info("🗃️ Found %d unfinished uploads", len(unfinished))
         for file_version in unfinished:
-            file_id = file_version.id_
+            # Use the correct attribute names for UnfinishedLargeFile objects
+            file_id = file_version.file_id
             file_name = file_version.file_name
             if self.dry_run:
                 self.logger.info(f"💡 Dry run: would cancel {file_id} ({file_name})")
             else:
                 self.logger.info(f"🗑️ Cancelling {file_id} ({file_name})")
-                self.api.cancel_large_file(file_id)
-
-
-@click.command()
-@click.argument("bucket")
-@click.option(
-    "--dry-run", is_flag=True, help="Only list unfinished uploads, do not cancel."
-)
-@click.option("--log-file", default="b2_cleanup.log", help="Path to log file.")
-@click.option("--key-id", help="Backblaze B2 applicationKeyId to override env/config.")
-@click.option("--key", help="Backblaze B2 applicationKey to override env/config.")
-def cli(bucket, dry_run, log_file, key_id, key):
-    """Clean up unfinished large file uploads in BUCKET."""
-    logger = logging.getLogger()
-    logger.setLevel(logging.INFO)
-    if logger.hasHandlers():
-        logger.handlers.clear()
-
-    file_handler = logging.FileHandler(log_file)
-    file_handler.setFormatter(
-        logging.Formatter("%(asctime)s [%(levelname)s] %(message)s")
-    )
-    logger.addHandler(file_handler)
-
-    stream_handler = logging.StreamHandler()
-    stream_handler.setFormatter(logging.Formatter("%(message)s"))
-    logger.addHandler(stream_handler)
-
-    tool = B2CleanupTool(dry_run=dry_run, override_key_id=key_id, override_key=key)
-    tool.cleanup_unfinished_uploads(bucket)
-
-
-if __name__ == "__main__":
-    cli()
+                self.api.cancel_large_file(file_id)

{b2_cleanup-0.1.3 → b2_cleanup-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "b2-cleanup"
-version = "0.1.3"
+version = "0.1.4"
 description = "CLI tool to clean up unfinished Backblaze B2 large uploads"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -26,14 +26,33 @@ dependencies = [
     "b2sdk>=1.20.0"
 ]
 
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "pytest-mock>=3.10.0"
+]
+
 [project.urls]
 "Homepage" = "https://github.com/your-username/b2-cleanup"
 "Issues" = "https://github.com/your-username/b2-cleanup/issues"
+"Changelog" = "https://github.com/your-username/b2-cleanup/blob/main/CHANGELOG.md"
 
 [project.scripts]
-b2-cleanup = "cleanup_unfinished_b2_uploads:cli"
+b2-cleanup = "b2_cleanup.cli:cli"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+python_functions = "test_*"
+python_classes = "Test*"
+addopts = "--cov=b2_cleanup --cov-report=term --cov-report=html"
 
 [build-system]
-requires = ["setuptools>=61.0"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+# Tell Hatchling which directories to include in the package
+[tool.hatch.build.targets.wheel]
+packages = ["b2_cleanup"]
 

b2_cleanup-0.1.4/setup.cfg

@@ -0,0 +1,10 @@
+[tool:pytest]
+testpaths = tests
+python_files = test_*.py
+python_functions = test_*
+python_classes = Test*
+addopts = --cov=b2_cleanup --cov-report=term --cov-report=html
+
+[coverage:run]
+source = b2_cleanup
+omit = tests/*