Skip to main content

A unified interface for AWS S3 and Google Cloud Storage operations

Project description

Cloud Storage Manager

A Python package for seamlessly managing file uploads across AWS S3 and Google Cloud Storage platforms.

Features

  • Unified interface for AWS S3 and Google Cloud Storage
  • Async operations support
  • Pre-signed URL generation
  • Easy file upload and deletion
  • Type-safe configuration using Pydantic
  • Comprehensive error handling
  • Logging support

Installation

pip install cloud-storage-manager

Quick Start

AWS S3 Example

import asyncio
from cloud_storage_manager import CloudStorageFactory, StorageProvider, StorageConfig, AwsConfig

async def main():
    # Configure AWS
    config = StorageConfig(
        aws=AwsConfig(
            bucket_name="my-bucket",
            access_key_id="your-access-key",
            secret_access_key="your-secret-key",
            region="us-east-1"  # optional, defaults to us-east-1
        )
    )
    
    # Create storage client
    storage = CloudStorageFactory.get_storage(StorageProvider.AWS, config)
    
    # Upload file
    cloud_path = await storage.upload("local/path/file.txt", "remote/path/file.txt")
    
    # Generate temporary URL
    url = await storage.get_public_url(cloud_path, expiration=3600)  # 1 hour expiration
    
    # Delete file
    success = await storage.delete(cloud_path)

asyncio.run(main())

Google Cloud Storage Example

import asyncio
from cloud_storage_manager import CloudStorageFactory, StorageProvider, StorageConfig, GcpConfig

async def main():
    # Configure GCP
    config = StorageConfig(
        gcp=GcpConfig(
            bucket_name="my-bucket",
            project_id="your-project-id",
            credentials={
                # Your service account credentials dictionary
            }
        )
    )
    
    # Create storage client
    storage = CloudStorageFactory.get_storage(StorageProvider.GCP, config)
    
    # Upload file
    cloud_path = await storage.upload("local/path/file.txt", "remote/path/file.txt")
    
    # Generate temporary URL
    url = await storage.get_public_url(cloud_path, expiration=3600)  # 1 hour expiration
    
    # Delete file
    success = await storage.delete(cloud_path)

asyncio.run(main())

Error Handling

The package provides specific exceptions for different types of errors:

from cloud_storage_manager import UploadError, DeleteError, DownloadError

try:
    await storage.upload("file.txt", "remote/file.txt")
except UploadError as e:
    print(f"Upload failed: {e}")

Configuration

AWS Configuration

  • bucket_name: Name of your S3 bucket
  • access_key_id: AWS access key ID
  • secret_access_key: AWS secret access key
  • region: AWS region (optional, defaults to us-east-1)

GCP Configuration

  • bucket_name: Name of your GCP bucket
  • project_id: Your GCP project ID
  • credentials: Service account credentials dictionary

Development

To contribute to the project:

# Clone the repository
git clone https://github.com/yourusername/cloud-storage-manager.git

# Create and activate virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloud_storage_manager-0.1.1.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cloud_storage_manager-0.1.1-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file cloud_storage_manager-0.1.1.tar.gz.

File metadata

  • Download URL: cloud_storage_manager-0.1.1.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for cloud_storage_manager-0.1.1.tar.gz
Algorithm Hash digest
SHA256 adaca53a7988235b8173466b0d1b67bd446cf51fcade1da328c6bfd0f961d635
MD5 0729aad97966e2671aff0b889b6e85ff
BLAKE2b-256 77c62b67bf12fd1e0ab756ef4f54c9c363dbf7bcc57285341ee87bb0e2cb96d8

See more details on using hashes here.

File details

Details for the file cloud_storage_manager-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for cloud_storage_manager-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 315c055ef35504c4324a71c2f4f426155644e06280a39843971d221747fd20d0
MD5 dda41bb56558ba66cdbfc54bda2d4358
BLAKE2b-256 afc5ccc4a045b6178d4cd76117223ced7476fa7f1a64d27acdecbe35cbf5c988

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page