mc-postgres-db 1.0.7__py3-none-any.whl → 1.0.9__py3-none-any.whl

mc_postgres_db-1.0.9.dist-info/METADATA

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: mc-postgres-db
+Version: 1.0.9
+Summary: Add your description here
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: alembic>=1.16.2
+Requires-Dist: psycopg2-binary>=2.9.10
+Requires-Dist: ruff>=0.12.0
+Requires-Dist: sqlalchemy>=2.0.41
+
+# MC Postgres DB
+
+A Python package containing ORM models for a PostgreSQL database that powers a personal quantitative trading and investment analysis platform.
+
+## Overview
+
+This package provides SQLAlchemy ORM models and database utilities for managing financial data, trading strategies, portfolio analytics, and market research. The database serves as the backbone for a personal "quant hedge fund" project, storing everything from market data and content data.
+
+## Features
+
+- **Asset Models**: `AssetType` and `Asset` tables for categorizing and managing financial instruments and various fiat and digital currencies
+- **Provider Models**: `ProviderType` and `Provider` tables for handling data sources and exchanges
+- **Market Data Models**: `ProviderAssetMarket` table for storing OHLCV and bid/ask price data
+- **Order Models**: `ProviderAssetOrder` table for tracking trading orders between assets
+- **Content Models**: `ContentType`, `ProviderContent`, and `AssetContent` tables for managing news articles and social content
+- **Relation Models**: `ProviderAsset` table for mapping relationships between providers and assets
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install mc-postgres-db
+```
+
+### From Source
+
+```bash
+# Clone the repository
+git clone <repository-url>
+cd mc-postgres-db
+
+# Install using uv (recommended)
+uv sync
+```
+
+## Database Setup
+
+1. **PostgreSQL Setup**: Ensure PostgreSQL is installed and running
+2. **Environment Variables**: Set up your database connection string
+   ```bash
+   export SQLALCHEMY_DATABASE_URL="postgresql://username:password@localhost:5432/mc_trading_db"
+   ```
+
+## Usage
+
+```python
+from sqlalchemy import create_engine, select
+from sqlalchemy.orm import Session
+from mcpdb.tables import Asset, Provider, ProviderAssetMarket
+
+# Create database connection
+url = "postgresql://username:password@localhost:5432/mc_trading_db"
+engine = create_engine(url)
+
+# Query assets
+with Session(engine) as session:
+    stmt = select(Asset).where(Asset.is_active)
+    assets = session.scalars(stmt).all()
+    asset_pairs = {asset.id: asset.name for asset in assets}
+    print("Available assets:")
+    for asset_id, asset_name in asset_pairs.items():
+        print(f"{asset_id}: {asset_name}")
+
+# Query market data
+with Session(engine) as session:
+    stmt = (
+        select(ProviderAssetMarket)
+        .where(
+            ProviderAssetMarket.asset_id == 1,  # Bitcoin for example
+            ProviderAssetMarket.provider_id == 2,  # Binance for example
+        )
+        .order_by(ProviderAssetMarket.timestamp.desc())
+        .limit(10)
+    )
+    market_data = session.scalars(stmt).all()
+    for data in market_data:
+        print(f"Timestamp: {data.timestamp}, Close: {data.close}, Volume: {data.volume}")
+
+# Get assets from a provider
+with Session(engine) as session:
+    stmt = select(Provider).where(Provider.id == 1)
+    provider = session.scalars(stmt).one()
+    provider_assets = provider.get_all_assets(engine)
+    print(f"Assets available from {provider.name}:")
+    for provider_asset in provider_assets:
+        print(f"Asset code: {provider_asset.asset_code}")
+```
+
+## Models Overview
+
+### Core Models
+
+- **AssetType**: Categorizes assets (e.g., stocks, bonds, cryptocurrencies) with names and descriptions
+- **Asset**: Represents financial instruments with references to asset types, symbols, and optional underlying assets
+- **ProviderType**: Categorizes data providers (e.g., exchanges, news services) with names and descriptions
+- **Provider**: Represents data sources with references to provider types and optional underlying providers
+- **ProviderAsset**: Maps the relationship between providers and assets with asset codes and active status
+- **ProviderAssetOrder**: Tracks orders for assets from providers including timestamp, price, and volume
+- **ProviderAssetMarket**: Stores OHLCV (Open, High, Low, Close, Volume) market data and bid/ask prices
+- **ContentType**: Categorizes content (e.g., news articles, social media posts) with names and descriptions
+- **ProviderContent**: Stores content from providers with timestamps, titles, descriptions, and full content
+- **AssetContent**: Maps the relationship between content and assets
+
+### Database Schema Features
+
+- **Inheritance Support**: Assets and providers can reference underlying entities for hierarchical relationships
+- **Timestamped Records**: All tables include creation and update timestamps
+- **Soft Delete Pattern**: Uses is_active flags to mark records as inactive without deletion
+- **Time Series Data**: Market data is organized by timestamp for efficient time-series operations
+- **Cross-Reference Tables**: Enables many-to-many relationships between assets, providers, and content
+
+## Development
+
+### Setting up Development Environment
+
+```bash
+# Install development dependencies using uv
+uv sync --dev
+
+# Run tests
+uv run pytest
+
+# Run linting
+uv run ruff check src/mcpdb/
+uv run ruff format src/mcpdb/
+```
+
+### Database Migrations
+
+```bash
+# Generate new migration
+uv run alembic revision --autogenerate -m "Description of changes"
+
+# Apply migrations
+uv run alembic upgrade head
+
+# Rollback migration
+uv run alembic downgrade -1
+```
+
+## Project Structure
+
+```
+mc-postgres-db/
+├── src/                 # Source code directory
+│   └── mcpdb/           # Package directory
+│       └── tables.py    # SQLAlchemy ORM models
+├── tests/               # Unit and integration tests
+├── scripts/             # Database maintenance scripts
+├── pyproject.toml       # Project configuration and dependencies
+├── uv.lock             # Locked dependency versions
+└── README.md           # Project documentation
+```
+
+## Data Sources
+
+This database integrates with various financial data providers:
+
+- Market data APIs (Alpha Vantage, IEX Cloud, etc.)
+- Fundamental data providers
+- Alternative data sources
+- Custom scraped data
+
+## Security & Compliance
+
+- Database connections use SSL encryption
+- Sensitive data is encrypted at rest
+- Access controls and audit logging implemented
+- Regular backups and disaster recovery procedures
+
+## Performance Considerations
+
+- Optimized indexes for common query patterns
+- Partitioned tables for large time-series data
+- Connection pooling for high-throughput operations
+- Caching layer for frequently accessed data
+
+## Contributing
+
+This is a personal project, but suggestions and improvements are welcome:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes with tests
+4. Submit a pull request
+
+## License
+
+This project is for personal use and learning purposes.
+
+## Disclaimer
+
+This software is for educational and personal use only. It is not intended for production trading or investment advice. Use at your own risk.

mc_postgres_db-1.0.9.dist-info/RECORD

@@ -0,0 +1,5 @@
+mcpdb/tables.py,sha256=6RWuE8eJzShSWG_wg_qgjwZ5UuhLu81JZiuTvRomOiM,11008
+mc_postgres_db-1.0.9.dist-info/METADATA,sha256=vYbruza1zMgKJQsb_uwaFYAqJMh_HgqGUKXThhrMpxY,7052
+mc_postgres_db-1.0.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mc_postgres_db-1.0.9.dist-info/top_level.txt,sha256=xiCw1E_-H0o0I8j5PbuWddHW1iwrGwntb2enCqa4FQA,6
+mc_postgres_db-1.0.9.dist-info/RECORD,,

mcpdb/tables.py

@@ -20,8 +20,8 @@ class AssetType(Base):
     __tablename__ = "asset_type"
 
     id: Mapped[int] = mapped_column(primary_key=True)
-    name: Mapped[str] = mapped_column(String(30), nullable=False)
-    description: Mapped[Optional[str]] = mapped_column(String(100), nullable=True)
+    name: Mapped[str] = mapped_column(String(100), nullable=False)
+    description: Mapped[Optional[str]] = mapped_column(String(1000), nullable=True)
     is_active: Mapped[bool] = mapped_column(default=True)
     created_at: Mapped[datetime.datetime] = mapped_column(
         nullable=False, server_default=func.now()
@@ -41,8 +41,12 @@ class Asset(Base):
     asset_type_id: Mapped[int] = mapped_column(
         ForeignKey("asset_type.id"), nullable=False
     )
-    name: Mapped[str] = mapped_column(String(30), nullable=False)
+    name: Mapped[str] = mapped_column(String(100), nullable=False)
     description: Mapped[Optional[str]]
+    symbol: Mapped[Optional[str]] = mapped_column(String(100), nullable=True)
+    underlying_asset_id: Mapped[Optional[int]] = mapped_column(
+        ForeignKey("asset.id"), nullable=True
+    )
     is_active: Mapped[bool] = mapped_column(default=True)
     created_at: Mapped[datetime.datetime] = mapped_column(
         nullable=False, server_default=func.now()
@@ -59,7 +63,7 @@ class ProviderType(Base):
     __tablename__ = "provider_type"
 
     id: Mapped[int] = mapped_column(primary_key=True)
-    name: Mapped[str] = mapped_column(String(30), nullable=False)
+    name: Mapped[str] = mapped_column(String(100), nullable=False)
     description: Mapped[Optional[str]] = mapped_column(String(1000), nullable=True)
     is_active: Mapped[bool] = mapped_column(default=True)
     created_at: Mapped[datetime.datetime] = mapped_column(
@@ -80,8 +84,12 @@ class Provider(Base):
     provider_type_id: Mapped[int] = mapped_column(
         ForeignKey("provider_type.id"), nullable=False
     )
-    name: Mapped[str] = mapped_column(String(30), nullable=False)
+    name: Mapped[str] = mapped_column(String(100), nullable=False)
     description: Mapped[Optional[str]] = mapped_column(String(1000), nullable=True)
+    symbol: Mapped[Optional[str]] = mapped_column(String(100), nullable=True)
+    underlying_provider_id: Mapped[Optional[int]] = mapped_column(
+        ForeignKey("provider.id"), nullable=True
+    )
     is_active: Mapped[bool] = mapped_column(default=True)
     created_at: Mapped[datetime.datetime] = mapped_column(
         nullable=False, server_default=func.now()
@@ -147,7 +155,7 @@ class ProviderAsset(Base):
     asset_id: Mapped[int] = mapped_column(
         ForeignKey("asset.id"), nullable=False, primary_key=True
     )
-    asset_code: Mapped[str] = mapped_column(String(30), nullable=False)
+    asset_code: Mapped[str] = mapped_column(String(100), nullable=False)
     is_active: Mapped[bool] = mapped_column(default=True)
     created_at: Mapped[datetime.datetime] = mapped_column(
         nullable=False, server_default=func.now()
@@ -203,7 +211,7 @@ class ContentType(Base):
     __tablename__ = "content_type"
 
     id: Mapped[int] = mapped_column(primary_key=True)
-    name: Mapped[str] = mapped_column(String(30), nullable=False)
+    name: Mapped[str] = mapped_column(String(100), nullable=False)
     description: Mapped[Optional[str]] = mapped_column(String(1000), nullable=True)
     is_active: Mapped[bool] = mapped_column(default=True)
     created_at: Mapped[datetime.datetime] = mapped_column(
@@ -223,14 +231,19 @@ class ProviderContent(Base):
     id: Mapped[int] = mapped_column(primary_key=True)
     timestamp: Mapped[datetime.datetime] = mapped_column(nullable=False)
     provider_id: Mapped[int] = mapped_column(ForeignKey("provider.id"), nullable=False)
-    provider_unique_identifier: Mapped[str] = mapped_column(
-        String(1000), nullable=False
+    provider_external_code: Mapped[str] = mapped_column(
+        String(1000),
+        nullable=False,
+        comment="This is the external identifier for the content and will depend on the content provider and the type of content. For example, for a news article, it could be the URL of the article and for a social media post, it could be the post ID.",
     )
     content_type_id: Mapped[int] = mapped_column(
         ForeignKey("content_type.id"), nullable=False
     )
-    author: Mapped[Optional[str]] = mapped_column(String(100), nullable=True)
-    title: Mapped[Optional[str]] = mapped_column(String(200), nullable=True)
+    authors: Mapped[Optional[str]] = mapped_column(String(1000), nullable=True)
+    title: Mapped[Optional[str]] = mapped_column(String(1000), nullable=True)
+    description: Mapped[Optional[str]] = mapped_column(
+        String(5000), nullable=True, comment="A short description of the content"
+    )
     content: Mapped[str] = mapped_column(String(), nullable=False)
     created_at: Mapped[datetime.datetime] = mapped_column(
         nullable=False, server_default=func.now()

mc_postgres_db-1.0.7.dist-info/METADATA

@@ -1,10 +0,0 @@
-Metadata-Version: 2.4
-Name: mc-postgres-db
-Version: 1.0.7
-Summary: Add your description here
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-Requires-Dist: alembic>=1.16.2
-Requires-Dist: psycopg2-binary>=2.9.10
-Requires-Dist: ruff>=0.12.0
-Requires-Dist: sqlalchemy>=2.0.41

mc_postgres_db-1.0.7.dist-info/RECORD

@@ -1,5 +0,0 @@
-mcpdb/tables.py,sha256=jeyQH3u7DvOxLpIM6u5AaSLrBaL5UxvXTFK29ytJ_A8,10201
-mc_postgres_db-1.0.7.dist-info/METADATA,sha256=Lwnx5ZHsUvxPpJRGVqH8JQBijeEtQFUHPmEwCj3bIfE,289
-mc_postgres_db-1.0.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mc_postgres_db-1.0.7.dist-info/top_level.txt,sha256=xiCw1E_-H0o0I8j5PbuWddHW1iwrGwntb2enCqa4FQA,6
-mc_postgres_db-1.0.7.dist-info/RECORD,,