elaunira-r2index 0.1.0__tar.gz

elaunira_r2index-0.1.0/.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+.wrangler/
+.dev.vars
+dist/

elaunira_r2index-0.1.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: elaunira-r2index
+Version: 0.1.0
+Summary: Python library for uploading files to R2 and registering them with the r2index API
+Project-URL: Homepage, https://github.com/elaunira/elaunira-r2-index
+Project-URL: Repository, https://github.com/elaunira/elaunira-r2-index
+Author: Elaunira
+License-Expression: MIT
+Keywords: cloudflare,index,r2,storage,upload
+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.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: aioboto3>=12.0.0
+Requires-Dist: boto3>=1.34.0
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: boto3-stubs[s3]>=1.34.0; extra == 'dev'
+Requires-Dist: build>=1.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.30.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.3.0; extra == 'dev'
+Requires-Dist: twine>=5.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# elaunira-r2index
+
+Python library for uploading files to Cloudflare R2 and registering them with the r2index API.
+
+## Installation
+
+```bash
+pip install elaunira-r2index
+```
+
+## Usage
+
+### Sync Client
+
+```python
+from elaunira.r2index import R2IndexClient, R2Config
+
+client = R2IndexClient(
+    api_url="https://r2index.example.com",
+    api_token="your-bearer-token",
+    r2_config=R2Config(
+        access_key_id="your-r2-access-key-id",
+        secret_access_key="your-r2-secret-access-key",
+        endpoint_url="https://your-account-id.r2.cloudflarestorage.com",
+        bucket="your-bucket-name",
+    ),
+)
+
+# Upload and register a file
+record = client.upload_and_register(
+    file_path="./myfile.zip",
+    category="software",
+    entity="myapp",
+    remote_path="/releases",
+    remote_filename="myapp-1.0.0.zip",
+    remote_version="1.0.0",
+    tags=["release", "stable"],
+)
+```
+
+### Async Client
+
+```python
+from elaunira.r2index import AsyncR2IndexClient, R2Config
+
+async with AsyncR2IndexClient(
+    api_url="https://r2index.example.com",
+    api_token="your-bearer-token",
+    r2_config=R2Config(
+        access_key_id="your-r2-access-key-id",
+        secret_access_key="your-r2-secret-access-key",
+        endpoint_url="https://your-account-id.r2.cloudflarestorage.com",
+        bucket="your-bucket-name",
+    ),
+) as client:
+    record = await client.upload_and_register(
+        file_path="./myfile.zip",
+        category="software",
+        entity="myapp",
+        remote_path="/releases",
+        remote_filename="myapp-1.0.0.zip",
+        remote_version="1.0.0",
+        tags=["release", "stable"],
+    )
+```
+
+## License
+
+MIT

elaunira_r2index-0.1.0/README.md

@@ -0,0 +1,69 @@
+# elaunira-r2index
+
+Python library for uploading files to Cloudflare R2 and registering them with the r2index API.
+
+## Installation
+
+```bash
+pip install elaunira-r2index
+```
+
+## Usage
+
+### Sync Client
+
+```python
+from elaunira.r2index import R2IndexClient, R2Config
+
+client = R2IndexClient(
+    api_url="https://r2index.example.com",
+    api_token="your-bearer-token",
+    r2_config=R2Config(
+        access_key_id="your-r2-access-key-id",
+        secret_access_key="your-r2-secret-access-key",
+        endpoint_url="https://your-account-id.r2.cloudflarestorage.com",
+        bucket="your-bucket-name",
+    ),
+)
+
+# Upload and register a file
+record = client.upload_and_register(
+    file_path="./myfile.zip",
+    category="software",
+    entity="myapp",
+    remote_path="/releases",
+    remote_filename="myapp-1.0.0.zip",
+    remote_version="1.0.0",
+    tags=["release", "stable"],
+)
+```
+
+### Async Client
+
+```python
+from elaunira.r2index import AsyncR2IndexClient, R2Config
+
+async with AsyncR2IndexClient(
+    api_url="https://r2index.example.com",
+    api_token="your-bearer-token",
+    r2_config=R2Config(
+        access_key_id="your-r2-access-key-id",
+        secret_access_key="your-r2-secret-access-key",
+        endpoint_url="https://your-account-id.r2.cloudflarestorage.com",
+        bucket="your-bucket-name",
+    ),
+) as client:
+    record = await client.upload_and_register(
+        file_path="./myfile.zip",
+        category="software",
+        entity="myapp",
+        remote_path="/releases",
+        remote_filename="myapp-1.0.0.zip",
+        remote_version="1.0.0",
+        tags=["release", "stable"],
+    )
+```
+
+## License
+
+MIT

elaunira_r2index-0.1.0/pyproject.toml

@@ -0,0 +1,83 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "elaunira-r2index"
+version = "0.1.0"
+description = "Python library for uploading files to R2 and registering them with the r2index API"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+authors = [
+    { name = "Elaunira" },
+]
+keywords = ["r2", "cloudflare", "storage", "upload", "index"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.25.0",
+    "boto3>=1.34.0",
+    "aioboto3>=12.0.0",
+    "pydantic>=2.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23.0",
+    "pytest-httpx>=0.30.0",
+    "ruff>=0.3.0",
+    "mypy>=1.8.0",
+    "boto3-stubs[s3]>=1.34.0",
+    "build>=1.0.0",
+    "twine>=5.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/elaunira/elaunira-r2-index"
+Repository = "https://github.com/elaunira/elaunira-r2-index"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/elaunira"]
+
+[tool.ruff]
+target-version = "py312"
+line-length = 100
+
+[tool.ruff.lint]
+select = [
+    "E",      # pycodestyle errors
+    "W",      # pycodestyle warnings
+    "F",      # Pyflakes
+    "I",      # isort
+    "B",      # flake8-bugbear
+    "C4",     # flake8-comprehensions
+    "UP",     # pyupgrade
+    "ARG",    # flake8-unused-arguments
+    "SIM",    # flake8-simplify
+]
+ignore = [
+    "E501",   # line too long (handled by formatter)
+    "B008",   # do not perform function calls in argument defaults
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["elaunira"]
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+warn_return_any = true
+warn_unused_ignores = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]

elaunira_r2index-0.1.0/scripts/publish.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Build package and publish to PyPI
+#
+# Requirements:
+#   - ~/.pypirc configured, OR
+#   - PYPI_TOKEN environment variable (API token from pypi.org)
+#
+# Usage:
+#   ./scripts/publish.sh
+
+cd "$(dirname "$0")/.."
+
+echo "Installing build dependencies..."
+pip install --quiet build twine
+
+echo "Cleaning previous builds..."
+rm -rf dist/ build/ *.egg-info src/*.egg-info
+
+echo "Building package..."
+python -m build
+
+echo "Publishing to PyPI..."
+if [[ -n "${PYPI_TOKEN:-}" ]]; then
+    twine upload \
+        --username __token__ \
+        --password "${PYPI_TOKEN}" \
+        dist/*
+else
+    twine upload dist/*
+fi
+
+echo "Done!"

elaunira_r2index-0.1.0/src/elaunira/__init__.py

@@ -0,0 +1 @@
+"""Elaunira namespace package."""

elaunira_r2index-0.1.0/src/elaunira/r2index/__init__.py

@@ -0,0 +1,118 @@
+"""
+R2 Index Python Library.
+
+A Python library for uploading files to Cloudflare R2 and registering them
+with the r2index API. Supports both sync and async operations with streaming
+checksums for memory-efficient handling of large files.
+
+Usage:
+    from elaunira.r2index import R2IndexClient, R2Config
+
+    client = R2IndexClient(
+        api_url="https://r2index.example.com",
+        api_token="your-bearer-token",
+        r2_config=R2Config(
+            access_key_id="...",
+            secret_access_key="...",
+            endpoint_url="https://xxx.r2.cloudflarestorage.com",
+            bucket="your-bucket",
+        ),
+    )
+
+    # Upload and register a file
+    record = client.upload_and_register(
+        file_path="./myfile.zip",
+        category="software",
+        entity="myapp",
+        remote_path="/releases",
+        remote_filename="myapp-1.0.0.zip",
+        remote_version="1.0.0",
+    )
+
+Async usage:
+    from elaunira.r2index import AsyncR2IndexClient, R2Config
+
+    async with AsyncR2IndexClient(...) as client:
+        record = await client.upload_and_register(...)
+"""
+
+from .async_client import AsyncR2IndexClient
+from .async_uploader import AsyncR2Uploader
+from .checksums import (
+    ChecksumResult,
+    compute_checksums,
+    compute_checksums_async,
+    compute_checksums_from_file_object,
+)
+from .client import R2IndexClient
+from .exceptions import (
+    AuthenticationError,
+    ConflictError,
+    NotFoundError,
+    R2IndexError,
+    UploadError,
+    ValidationError,
+)
+from .models import (
+    CleanupResponse,
+    DownloadByIpEntry,
+    DownloadRecord,
+    DownloadRecordRequest,
+    DownloadsByIpResponse,
+    FileCreateRequest,
+    FileListResponse,
+    FileRecord,
+    FileUpdateRequest,
+    HealthResponse,
+    IndexEntry,
+    RemoteTuple,
+    SummaryResponse,
+    TimeseriesDataPoint,
+    TimeseriesResponse,
+    UserAgentEntry,
+    UserAgentsResponse,
+)
+from .uploader import R2Config, R2Uploader
+
+__all__ = [
+    # Clients
+    "R2IndexClient",
+    "AsyncR2IndexClient",
+    # Uploaders
+    "R2Uploader",
+    "AsyncR2Uploader",
+    "R2Config",
+    # Checksums
+    "ChecksumResult",
+    "compute_checksums",
+    "compute_checksums_async",
+    "compute_checksums_from_file_object",
+    # Exceptions
+    "R2IndexError",
+    "AuthenticationError",
+    "NotFoundError",
+    "ValidationError",
+    "ConflictError",
+    "UploadError",
+    # Models - File operations
+    "FileRecord",
+    "FileCreateRequest",
+    "FileUpdateRequest",
+    "FileListResponse",
+    "IndexEntry",
+    "RemoteTuple",
+    # Models - Downloads
+    "DownloadRecord",
+    "DownloadRecordRequest",
+    # Models - Analytics
+    "TimeseriesDataPoint",
+    "TimeseriesResponse",
+    "SummaryResponse",
+    "DownloadByIpEntry",
+    "DownloadsByIpResponse",
+    "UserAgentEntry",
+    "UserAgentsResponse",
+    # Models - Other
+    "CleanupResponse",
+    "HealthResponse",
+]