ff-storage 0.1.4__tar.gz

ff_storage-0.1.4/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: ff-storage
+Version: 0.1.4
+Summary: Fenixflow storage package for database and file operations
+Author-email: Fenixflow <dev@fenixflow.com>
+License: Proprietary
+Project-URL: repository, https://gitlab.com/fenixflow/fenix-packages
+Project-URL: documentation, https://gitlab.com/fenixflow/fenix-packages/-/tree/main/ff-storage
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: psycopg2-binary>=2.9
+Requires-Dist: asyncpg>=0.29
+Requires-Dist: pymysql>=1.1
+Requires-Dist: mysql-connector-python>=8.0
+Requires-Dist: boto3>=1.34
+Requires-Dist: azure-storage-blob>=12.19
+Requires-Dist: aiofiles>=23.0.0
+Requires-Dist: aioboto3>=12.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: ruff>=0.1; extra == "dev"
+Requires-Dist: moto[s3]>=5.0.0; extra == "dev"
+Requires-Dist: aioboto3>=12.0.0; extra == "dev"
+
+# ff-storage
+
+Database and object storage operations for Fenixflow applications.
+
+## Features
+
+- **Database Connections**: PostgreSQL and MySQL with connection pooling
+- **Multi-Database Support**: Consistent API for PostgreSQL and MySQL
+- **Migration Management**: Simple SQL file-based migrations
+- **Object Storage**: Async local filesystem and S3/S3-compatible storage
+- **Streaming Support**: Read/write large files without loading into memory
+- **Atomic Operations**: Safe file writes with temp file + rename
+- **Metadata Management**: Store and retrieve metadata with objects
+- **Base Models**: Dataclass-based models with UUID and timestamp support
+- **Query Builder**: SQL query construction utilities
+
+## Installation
+
+```bash
+# From GitLab
+pip install git+https://gitlab.com/fenixflow/fenix-packages.git@main#subdirectory=ff-storage
+
+# Local development
+pip install -e .
+```
+
+## Usage
+
+### PostgreSQL Connection
+
+```python
+from ff_storage import PostgresPool
+
+# Create connection pool
+db = PostgresPool(
+    dbname="fenix_db",
+    user="fenix",
+    password="password",
+    host="localhost",
+    port=5432,
+    pool_size=20
+)
+
+# Connect and execute query
+db.connect()
+results = db.read_query("SELECT * FROM documents WHERE status = %s", {"status": "active"})
+
+# Execute with RETURNING
+new_id = db.execute_query(
+    "INSERT INTO documents (title) VALUES (%s) RETURNING id",
+    {"title": "New Document"}
+)
+
+# Return connection to pool
+db.close_connection()
+```
+
+### MySQL Connection
+
+```python
+from ff_storage import MySQLPool
+
+# Create connection pool
+db = MySQLPool(
+    dbname="fenix_db",
+    user="root",
+    password="password",
+    host="localhost",
+    port=3306,
+    pool_size=10
+)
+
+# Connect and execute query
+db.connect()
+results = db.read_query("SELECT * FROM documents WHERE status = %s", {"status": "active"})
+
+# Execute INSERT (returns last insert ID)
+new_id = db.execute_query(
+    "INSERT INTO documents (title) VALUES (%s)",
+    {"title": "New Document"}
+)
+
+# Check open connections
+open_conns = db.get_open_connections()
+
+# Return connection to pool
+db.close_connection()
+```
+
+### Migrations
+
+```python
+from ff_storage.db.migrations import MigrationManager
+
+# Setup migration manager
+manager = MigrationManager(db_connection, "./migrations")
+
+# Run all pending migrations
+manager.migrate()
+```
+
+### Object Storage
+
+```python
+from ff_storage import LocalObjectStorage, S3ObjectStorage
+import asyncio
+
+async def main():
+    # Local filesystem storage
+    local = LocalObjectStorage("/var/data/documents")
+    await local.write("docs/report.pdf", pdf_bytes, {"content-type": "application/pdf"})
+    data = await local.read("docs/report.pdf")
+    exists = await local.exists("docs/report.pdf")
+    files = await local.list_keys(prefix="docs/")
+    
+    # S3 storage (AWS or S3-compatible)
+    s3 = S3ObjectStorage(
+        bucket="fenix-documents",
+        region="us-east-1"
+    )
+    await s3.write("docs/report.pdf", pdf_bytes)
+    data = await s3.read("docs/report.pdf")
+    
+    # Stream large files
+    async for chunk in s3.read_stream("large_file.bin", chunk_size=8192):
+        process_chunk(chunk)
+
+asyncio.run(main())
+```
+
+## Database Classes
+
+### SQL Base Class
+Abstract base providing interface for all SQL operations:
+- `connect()`: Establish connection
+- `read_query()`: Execute SELECT queries
+- `execute()`: Execute INSERT/UPDATE/DELETE
+- `execute_query()`: Execute with RETURNING
+- `execute_many()`: Batch operations
+- Transaction management methods
+
+### PostgreSQL
+- `Postgres`: Direct connection without pooling
+- `PostgresPool`: Connection pooling for production use
+
+### MySQL
+- `MySQL`: Direct connection without pooling
+- `MySQLPool`: Connection pooling for production use
+
+## Testing
+
+```bash
+# Run tests
+pytest tests/
+
+# With coverage
+pytest --cov=ff_storage tests/
+```
+
+## License
+
+Proprietary - Fenixflow Internal Use Only

ff_storage-0.1.4/README.md

@@ -0,0 +1,162 @@
+# ff-storage
+
+Database and object storage operations for Fenixflow applications.
+
+## Features
+
+- **Database Connections**: PostgreSQL and MySQL with connection pooling
+- **Multi-Database Support**: Consistent API for PostgreSQL and MySQL
+- **Migration Management**: Simple SQL file-based migrations
+- **Object Storage**: Async local filesystem and S3/S3-compatible storage
+- **Streaming Support**: Read/write large files without loading into memory
+- **Atomic Operations**: Safe file writes with temp file + rename
+- **Metadata Management**: Store and retrieve metadata with objects
+- **Base Models**: Dataclass-based models with UUID and timestamp support
+- **Query Builder**: SQL query construction utilities
+
+## Installation
+
+```bash
+# From GitLab
+pip install git+https://gitlab.com/fenixflow/fenix-packages.git@main#subdirectory=ff-storage
+
+# Local development
+pip install -e .
+```
+
+## Usage
+
+### PostgreSQL Connection
+
+```python
+from ff_storage import PostgresPool
+
+# Create connection pool
+db = PostgresPool(
+    dbname="fenix_db",
+    user="fenix",
+    password="password",
+    host="localhost",
+    port=5432,
+    pool_size=20
+)
+
+# Connect and execute query
+db.connect()
+results = db.read_query("SELECT * FROM documents WHERE status = %s", {"status": "active"})
+
+# Execute with RETURNING
+new_id = db.execute_query(
+    "INSERT INTO documents (title) VALUES (%s) RETURNING id",
+    {"title": "New Document"}
+)
+
+# Return connection to pool
+db.close_connection()
+```
+
+### MySQL Connection
+
+```python
+from ff_storage import MySQLPool
+
+# Create connection pool
+db = MySQLPool(
+    dbname="fenix_db",
+    user="root",
+    password="password",
+    host="localhost",
+    port=3306,
+    pool_size=10
+)
+
+# Connect and execute query
+db.connect()
+results = db.read_query("SELECT * FROM documents WHERE status = %s", {"status": "active"})
+
+# Execute INSERT (returns last insert ID)
+new_id = db.execute_query(
+    "INSERT INTO documents (title) VALUES (%s)",
+    {"title": "New Document"}
+)
+
+# Check open connections
+open_conns = db.get_open_connections()
+
+# Return connection to pool
+db.close_connection()
+```
+
+### Migrations
+
+```python
+from ff_storage.db.migrations import MigrationManager
+
+# Setup migration manager
+manager = MigrationManager(db_connection, "./migrations")
+
+# Run all pending migrations
+manager.migrate()
+```
+
+### Object Storage
+
+```python
+from ff_storage import LocalObjectStorage, S3ObjectStorage
+import asyncio
+
+async def main():
+    # Local filesystem storage
+    local = LocalObjectStorage("/var/data/documents")
+    await local.write("docs/report.pdf", pdf_bytes, {"content-type": "application/pdf"})
+    data = await local.read("docs/report.pdf")
+    exists = await local.exists("docs/report.pdf")
+    files = await local.list_keys(prefix="docs/")
+    
+    # S3 storage (AWS or S3-compatible)
+    s3 = S3ObjectStorage(
+        bucket="fenix-documents",
+        region="us-east-1"
+    )
+    await s3.write("docs/report.pdf", pdf_bytes)
+    data = await s3.read("docs/report.pdf")
+    
+    # Stream large files
+    async for chunk in s3.read_stream("large_file.bin", chunk_size=8192):
+        process_chunk(chunk)
+
+asyncio.run(main())
+```
+
+## Database Classes
+
+### SQL Base Class
+Abstract base providing interface for all SQL operations:
+- `connect()`: Establish connection
+- `read_query()`: Execute SELECT queries
+- `execute()`: Execute INSERT/UPDATE/DELETE
+- `execute_query()`: Execute with RETURNING
+- `execute_many()`: Batch operations
+- Transaction management methods
+
+### PostgreSQL
+- `Postgres`: Direct connection without pooling
+- `PostgresPool`: Connection pooling for production use
+
+### MySQL
+- `MySQL`: Direct connection without pooling
+- `MySQLPool`: Connection pooling for production use
+
+## Testing
+
+```bash
+# Run tests
+pytest tests/
+
+# With coverage
+pytest --cov=ff_storage tests/
+```
+
+## License
+
+Proprietary - Fenixflow Internal Use Only

ff_storage-0.1.4/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ff-storage"
+version = "0.1.4"
+description = "Fenixflow storage package for database and file operations"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "Proprietary"}
+authors = [
+    {name = "Fenixflow", email = "dev@fenixflow.com"}
+]
+dependencies = [
+    "psycopg2-binary>=2.9",
+    "asyncpg>=0.29",
+    "pymysql>=1.1",
+    "mysql-connector-python>=8.0",
+    "boto3>=1.34",
+    "azure-storage-blob>=12.19",
+    "aiofiles>=23.0.0",
+    "aioboto3>=12.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4",
+    "pytest-asyncio>=0.21",
+    "black>=23.0",
+    "ruff>=0.1",
+    "moto[s3]>=5.0.0",
+    "aioboto3>=12.0.0",
+]
+
+[project.urls]
+repository = "https://gitlab.com/fenixflow/fenix-packages"
+documentation = "https://gitlab.com/fenixflow/fenix-packages/-/tree/main/ff-storage"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.black]
+line-length = 100
+target-version = ["py310", "py311"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.4.1",
+]

ff_storage-0.1.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ff_storage-0.1.4/src/ff_storage/__init__.py

@@ -0,0 +1,28 @@
+"""
+ff-storage: Database and file storage operations for Fenixflow applications.
+"""
+
+__version__ = "0.1.0"
+
+# Database exports
+from .db.postgres import Postgres, PostgresPool
+from .db.mysql import MySQL, MySQLPool
+from .db.migrations import MigrationManager
+
+# Object storage exports
+from .object import ObjectStorage, LocalObjectStorage, S3ObjectStorage
+
+__all__ = [
+    # PostgreSQL
+    "Postgres",
+    "PostgresPool",
+    # MySQL
+    "MySQL",
+    "MySQLPool",
+    # Migrations
+    "MigrationManager",
+    # Object Storage
+    "ObjectStorage",
+    "LocalObjectStorage",
+    "S3ObjectStorage",
+]

ff_storage-0.1.4/src/ff_storage/db/__init__.py

@@ -0,0 +1,22 @@
+"""
+Database connection and operation modules.
+"""
+
+from .sql import SQL
+from .postgres import Postgres, PostgresPool, PostgresBase
+from .mysql import MySQL, MySQLPool, MySQLBase
+from .migrations import MigrationManager
+
+__all__ = [
+    "SQL",
+    # PostgreSQL
+    "Postgres",
+    "PostgresPool",
+    "PostgresBase",
+    # MySQL
+    "MySQL",
+    "MySQLPool",
+    "MySQLBase",
+    # Migrations
+    "MigrationManager",
+]