elaunira-r2index 0.1.0__tar.gz → 0.3.0__tar.gz

elaunira_r2index-0.3.0/.gitignore

@@ -0,0 +1,27 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# mypy
+.mypy_cache/

elaunira_r2index-0.3.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: elaunira-r2index
+Version: 0.3.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>=13.0.0
+Requires-Dist: boto3>=1.35.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.10.0
+Provides-Extra: dev
+Requires-Dist: boto3-stubs[s3]>=1.35.0; extra == 'dev'
+Requires-Dist: build>=1.2.0; extra == 'dev'
+Requires-Dist: mypy>=1.15.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.25.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.35.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.9.0; extra == 'dev'
+Requires-Dist: twine>=6.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# elaunira-r2index
+
+Python library for uploading and downloading files to/from Cloudflare R2 with the r2index API.
+
+## Installation
+
+```bash
+pip install elaunira-r2index
+```
+
+## Usage
+
+### Sync Client
+
+```python
+from elaunira.r2index import R2IndexClient
+
+client = R2IndexClient(
+    index_api_url="https://r2index.example.com",
+    index_api_token="your-bearer-token",
+    r2_access_key_id="your-r2-access-key-id",
+    r2_secret_access_key="your-r2-secret-access-key",
+    r2_endpoint_url="https://your-account-id.r2.cloudflarestorage.com",
+)
+
+# Upload and register a file
+record = client.upload(
+    bucket="my-bucket",
+    local_path="./myfile.zip",
+    category="software",
+    entity="myapp",
+    remote_path="/releases/myapp",
+    remote_filename="myapp.zip",
+    remote_version="v1",
+    tags=["release", "stable"],
+)
+
+# Download a file and record the download
+# IP address is auto-detected, user agent defaults to "elaunira-r2index/<version>"
+path, record = client.download(
+    bucket="my-bucket",
+    object_id="/releases/myapp/v1/myapp.zip",
+    destination="./downloads/myfile.zip",
+)
+```
+
+### Async Client
+
+```python
+from elaunira.r2index import AsyncR2IndexClient
+
+async with AsyncR2IndexClient(
+    index_api_url="https://r2index.example.com",
+    index_api_token="your-bearer-token",
+    r2_access_key_id="your-r2-access-key-id",
+    r2_secret_access_key="your-r2-secret-access-key",
+    r2_endpoint_url="https://your-account-id.r2.cloudflarestorage.com",
+) as client:
+    # Upload
+    record = await client.upload(
+        bucket="my-bucket",
+        local_path="./myfile.zip",
+        category="software",
+        entity="myapp",
+        remote_path="/releases/myapp",
+        remote_filename="myapp.zip",
+        remote_version="v1",
+        tags=["release", "stable"],
+    )
+
+    # Download
+    path, record = await client.download(
+        bucket="my-bucket",
+        object_id="/releases/myapp/v1/myapp.zip",
+        destination="./downloads/myfile.zip",
+    )
+```
+
+### Transfer Configuration
+
+Control multipart transfer settings with `R2TransferConfig`:
+
+```python
+from elaunira.r2index import R2IndexClient, R2TransferConfig
+
+client = R2IndexClient(
+    index_api_url="https://r2index.example.com",
+    index_api_token="your-bearer-token",
+    r2_access_key_id="your-r2-access-key-id",
+    r2_secret_access_key="your-r2-secret-access-key",
+    r2_endpoint_url="https://your-account-id.r2.cloudflarestorage.com",
+)
+
+# Custom transfer settings
+transfer_config = R2TransferConfig(
+    multipart_threshold=100 * 1024 * 1024,  # 100MB (default)
+    multipart_chunksize=32 * 1024 * 1024,   # 32MB chunks
+    max_concurrency=64,                      # 64 parallel threads
+    use_threads=True,                        # Enable threading (default)
+)
+
+path, record = client.download(
+    bucket="my-bucket",
+    object_id="/data/files/v2/largefile.zip",
+    destination="./downloads/largefile.zip",
+    transfer_config=transfer_config,
+)
+```
+
+Default `max_concurrency` is 2x the number of CPU cores (minimum 4).
+
+### Progress Tracking
+
+```python
+def on_progress(bytes_transferred: int) -> None:
+    print(f"Downloaded: {bytes_transferred / 1024 / 1024:.1f} MB")
+
+path, record = client.download(
+    bucket="my-bucket",
+    object_id="/releases/myapp/v1/myapp.zip",
+    destination="./downloads/myfile.zip",
+    progress_callback=on_progress,
+)
+```
+
+## License
+
+MIT

elaunira_r2index-0.3.0/README.md

@@ -0,0 +1,128 @@
+# elaunira-r2index
+
+Python library for uploading and downloading files to/from Cloudflare R2 with the r2index API.
+
+## Installation
+
+```bash
+pip install elaunira-r2index
+```
+
+## Usage
+
+### Sync Client
+
+```python
+from elaunira.r2index import R2IndexClient
+
+client = R2IndexClient(
+    index_api_url="https://r2index.example.com",
+    index_api_token="your-bearer-token",
+    r2_access_key_id="your-r2-access-key-id",
+    r2_secret_access_key="your-r2-secret-access-key",
+    r2_endpoint_url="https://your-account-id.r2.cloudflarestorage.com",
+)
+
+# Upload and register a file
+record = client.upload(
+    bucket="my-bucket",
+    local_path="./myfile.zip",
+    category="software",
+    entity="myapp",
+    remote_path="/releases/myapp",
+    remote_filename="myapp.zip",
+    remote_version="v1",
+    tags=["release", "stable"],
+)
+
+# Download a file and record the download
+# IP address is auto-detected, user agent defaults to "elaunira-r2index/<version>"
+path, record = client.download(
+    bucket="my-bucket",
+    object_id="/releases/myapp/v1/myapp.zip",
+    destination="./downloads/myfile.zip",
+)
+```
+
+### Async Client
+
+```python
+from elaunira.r2index import AsyncR2IndexClient
+
+async with AsyncR2IndexClient(
+    index_api_url="https://r2index.example.com",
+    index_api_token="your-bearer-token",
+    r2_access_key_id="your-r2-access-key-id",
+    r2_secret_access_key="your-r2-secret-access-key",
+    r2_endpoint_url="https://your-account-id.r2.cloudflarestorage.com",
+) as client:
+    # Upload
+    record = await client.upload(
+        bucket="my-bucket",
+        local_path="./myfile.zip",
+        category="software",
+        entity="myapp",
+        remote_path="/releases/myapp",
+        remote_filename="myapp.zip",
+        remote_version="v1",
+        tags=["release", "stable"],
+    )
+
+    # Download
+    path, record = await client.download(
+        bucket="my-bucket",
+        object_id="/releases/myapp/v1/myapp.zip",
+        destination="./downloads/myfile.zip",
+    )
+```
+
+### Transfer Configuration
+
+Control multipart transfer settings with `R2TransferConfig`:
+
+```python
+from elaunira.r2index import R2IndexClient, R2TransferConfig
+
+client = R2IndexClient(
+    index_api_url="https://r2index.example.com",
+    index_api_token="your-bearer-token",
+    r2_access_key_id="your-r2-access-key-id",
+    r2_secret_access_key="your-r2-secret-access-key",
+    r2_endpoint_url="https://your-account-id.r2.cloudflarestorage.com",
+)
+
+# Custom transfer settings
+transfer_config = R2TransferConfig(
+    multipart_threshold=100 * 1024 * 1024,  # 100MB (default)
+    multipart_chunksize=32 * 1024 * 1024,   # 32MB chunks
+    max_concurrency=64,                      # 64 parallel threads
+    use_threads=True,                        # Enable threading (default)
+)
+
+path, record = client.download(
+    bucket="my-bucket",
+    object_id="/data/files/v2/largefile.zip",
+    destination="./downloads/largefile.zip",
+    transfer_config=transfer_config,
+)
+```
+
+Default `max_concurrency` is 2x the number of CPU cores (minimum 4).
+
+### Progress Tracking
+
+```python
+def on_progress(bytes_transferred: int) -> None:
+    print(f"Downloaded: {bytes_transferred / 1024 / 1024:.1f} MB")
+
+path, record = client.download(
+    bucket="my-bucket",
+    object_id="/releases/myapp/v1/myapp.zip",
+    destination="./downloads/myfile.zip",
+    progress_callback=on_progress,
+)
+```
+
+## License
+
+MIT

{elaunira_r2index-0.1.0 → elaunira_r2index-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "elaunira-r2index"
-version = "0.1.0"
+version = "0.3.0"
 description = "Python library for uploading files to R2 and registering them with the r2index API"
 readme = "README.md"
 license = "MIT"
@@ -23,22 +23,22 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "httpx>=0.25.0",
-    "boto3>=1.34.0",
-    "aioboto3>=12.0.0",
-    "pydantic>=2.0.0",
+    "aioboto3>=13.0.0",
+    "boto3>=1.35.0",
+    "httpx>=0.27.0",
+    "pydantic>=2.10.0",
 ]
 
 [project.optional-dependencies]
 dev = [
+    "boto3-stubs[s3]>=1.35.0",
+    "build>=1.2.0",
+    "mypy>=1.15.0",
     "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",
+    "pytest-asyncio>=0.25.0",
+    "pytest-httpx>=0.35.0",
+    "ruff>=0.9.0",
+    "twine>=6.0.0",
 ]
 
 [project.urls]
@@ -77,6 +77,11 @@ python_version = "3.12"
 strict = true
 warn_return_any = true
 warn_unused_ignores = true
+plugins = ["pydantic.mypy"]
+
+[[tool.mypy.overrides]]
+module = ["aioboto3", "aioboto3.*", "aiobotocore", "aiobotocore.*"]
+ignore_missing_imports = true
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"

{elaunira_r2index-0.1.0 → elaunira_r2index-0.3.0}/src/elaunira/r2index/__init__.py

@@ -1,43 +1,11 @@
-"""
-R2 Index Python Library.
+"""Python library for uploading and downloading files to/from Cloudflare R2 with the r2index API."""
 
-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.
+from importlib.metadata import version
 
-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(...)
-"""
+__version__ = version("elaunira-r2index")
 
 from .async_client import AsyncR2IndexClient
-from .async_uploader import AsyncR2Uploader
+from .async_storage import AsyncR2Storage
 from .checksums import (
     ChecksumResult,
     compute_checksums,
@@ -48,6 +16,7 @@ from .client import R2IndexClient
 from .exceptions import (
     AuthenticationError,
     ConflictError,
+    DownloadError,
     NotFoundError,
     R2IndexError,
     UploadError,
@@ -72,44 +41,48 @@ from .models import (
     UserAgentEntry,
     UserAgentsResponse,
 )
-from .uploader import R2Config, R2Uploader
+from .storage import R2Config, R2Storage, R2TransferConfig
 
 __all__ = [
+    # Version
+    "__version__",
     # Clients
-    "R2IndexClient",
     "AsyncR2IndexClient",
-    # Uploaders
-    "R2Uploader",
-    "AsyncR2Uploader",
+    "R2IndexClient",
+    # Storage
+    "AsyncR2Storage",
     "R2Config",
+    "R2Storage",
+    "R2TransferConfig",
     # Checksums
     "ChecksumResult",
     "compute_checksums",
     "compute_checksums_async",
     "compute_checksums_from_file_object",
     # Exceptions
-    "R2IndexError",
     "AuthenticationError",
-    "NotFoundError",
-    "ValidationError",
     "ConflictError",
+    "DownloadError",
+    "NotFoundError",
+    "R2IndexError",
     "UploadError",
+    "ValidationError",
     # Models - File operations
-    "FileRecord",
     "FileCreateRequest",
-    "FileUpdateRequest",
     "FileListResponse",
+    "FileRecord",
+    "FileUpdateRequest",
     "IndexEntry",
     "RemoteTuple",
     # Models - Downloads
     "DownloadRecord",
     "DownloadRecordRequest",
     # Models - Analytics
-    "TimeseriesDataPoint",
-    "TimeseriesResponse",
-    "SummaryResponse",
     "DownloadByIpEntry",
     "DownloadsByIpResponse",
+    "SummaryResponse",
+    "TimeseriesDataPoint",
+    "TimeseriesResponse",
     "UserAgentEntry",
     "UserAgentsResponse",
     # Models - Other