ecom-foundation-core 0.1.0__tar.gz

ecom_foundation_core-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev,postgres]"
+
+      - name: Lint with ruff
+        run: |
+          ruff check src/ecom_foundation_core tests/
+
+      - name: Type check with mypy
+        run: |
+          mypy src/ecom_foundation_core
+
+      - name: Test with pytest
+        run: |
+          pytest tests/ -v --cov=ecom_foundation_core --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          file: ./coverage.xml

ecom_foundation_core-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,42 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package
+        run: twine check dist/*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          generate_release_notes: true

ecom_foundation_core-0.1.0/.gitignore

@@ -0,0 +1,159 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+
+# C extensions
+*.so
+
+# Distribution / packaging
+bin/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script that run at build time
+#  interactively, so they don't contain sensitive information.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+pytest_debug_log.txt
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or binary, you wish to ignore .python-version.
+#   For a specific project, you may want to include it.
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or even
+#   fail to install them.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+
+# PEP 582; used by e.g. github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+.idea/
+
+# VS Code
+.vscode/
+
+# Project specific
+*.whl
+*.gz
+logs/
+temp/

ecom_foundation_core-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-toml
+
+  # - repo: https://github.com/astral-sh/ruff-pre-commit
+  #   rev: v0.1.6
+  #   hooks:
+  #     - id: ruff
+  #       args: [--fix, --exit-non-zero-on-fix]
+
+  - repo: https://github.com/psf/black
+    rev: 23.11.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.7.0
+    hooks:
+      - id: mypy
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.3
+    hooks:
+      - id: prettier
+        types_or: [markdown, yaml, json]

ecom_foundation_core-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11.8

ecom_foundation_core-0.1.0/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## [0.1.0] - 2024-01-15
+
+### Added
+
+- Initial release with auth, notifications, and billing modules
+- FastAPI application factory
+- SQLAlchemy models and migrations
+- SendGrid and Twilio integrations
+
+### Changed
+
+- N/A
+
+### Deprecated
+
+- N/A
+
+### Removed
+
+- N/A
+
+### Fixed
+
+- N/A

ecom_foundation_core-0.1.0/Dockerfile.test

@@ -0,0 +1,15 @@
+FROM python:3.11-slim
+
+WORKDIR /app
+
+# Upgrade pip
+RUN pip install --upgrade pip
+
+# Copy the whole core foundation directory
+COPY . /app
+
+# Install it in editable mode with dev dependencies
+RUN pip install -e ".[dev]"
+
+# Command to run tests
+CMD ["pytest", "tests/", "-v"]

ecom_foundation_core-0.1.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2024 e-com services limited. All rights reserved.
+
+Proprietary and Confidential.
+
+This software and its associated documentation are the exclusive property of e-com services limited.
+Unauthorized copying, distribution, or use of this software, via any medium, is strictly prohibited.
+Any use of this software requires a valid, written license agreement from e-com services limited.

ecom_foundation_core-0.1.0/Makefile

@@ -0,0 +1,39 @@
+.PHONY: install dev test lint format clean build publish docs
+
+install:
+	pip install -e ".[dev]"
+
+dev: install
+	pre-commit install
+
+test:
+	pytest tests/ -v --cov=ecom_foundation_core --cov-report=term-missing
+
+lint:
+	ruff check src/ecom_foundation_core tests/
+	mypy src/ecom_foundation_core
+
+format:
+	ruff format src/ecom_foundation_core tests/
+
+clean:
+	rm -rf build/
+	rm -rf dist/
+	rm -rf *.egg-info
+	find . -type f -name "*.pyc" -delete
+	find . -type d -name __pycache__ -delete
+
+build: clean
+	python -m build
+
+publish-test:
+	twine upload --repository testpypi dist/*
+
+publish:
+	twine upload dist/*
+
+docs:
+	cd docs && make html
+
+check-stability:
+	docker compose -f docker-compose.test.yml run --rm test_suite pytest tests/ -vv

ecom_foundation_core-0.1.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: ecom-foundation-core
+Version: 0.1.0
+Summary: E-Com Foundation Platform: A modular foundation for building high-performance enterprise microservices, powering systems like the International Regulatory Management System (IRMS).
+Project-URL: Homepage, https://github.com/E-com-services-Ltd/platform-core
+Project-URL: Documentation, https://github.com/E-com-services-Ltd/platform-core
+Project-URL: Repository, https://github.com/E-com-services-Ltd/platform-core
+Project-URL: Changelog, https://github.com/E-com-services-Ltd/platform-core/blob/main/CHANGELOG.md
+Author-email: e-com services limited <technical@e-comservicesgh.com>
+License: Proprietary
+License-File: LICENSE
+Keywords: enterprise,fastapi,foundation,platform
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.11
+Requires-Dist: alembic>=1.13.0
+Requires-Dist: celery>=5.3.0
+Requires-Dist: email-validator>=2.1.0
+Requires-Dist: fastapi>=0.104.0
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: passlib[bcrypt]>=1.7.4
+Requires-Dist: phonenumbers>=8.13.0
+Requires-Dist: prometheus-client>=0.19.0
+Requires-Dist: pydantic-settings>=2.1.0
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: pyotp>=2.9.0
+Requires-Dist: python-jose[cryptography]>=3.3.0
+Requires-Dist: python-multipart>=0.0.6
+Requires-Dist: redis>=5.0.0
+Requires-Dist: sendgrid>=6.11.0
+Requires-Dist: sqlalchemy>=2.0.0
+Requires-Dist: stripe>=7.0.0
+Requires-Dist: structlog>=23.2.0
+Requires-Dist: uvicorn[standard]>=0.24.0
+Provides-Extra: aws
+Requires-Dist: boto3>=1.34.0; extra == 'aws'
+Provides-Extra: dev
+Requires-Dist: black>=23.11.0; extra == 'dev'
+Requires-Dist: faker>=20.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.7.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.5.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: mysql
+Requires-Dist: aiomysql>=0.2.0; extra == 'mysql'
+Requires-Dist: mysqlclient>=2.2.0; extra == 'mysql'
+Provides-Extra: postgres
+Requires-Dist: asyncpg>=0.29.0; extra == 'postgres'
+Requires-Dist: psycopg2-binary>=2.9.0; extra == 'postgres'
+Provides-Extra: sentry
+Requires-Dist: sentry-sdk>=1.35.0; extra == 'sentry'
+Description-Content-Type: text/markdown
+
+# E-Com Foundation Core
+
+A production-ready foundation for high-performance enterprise microservices. Built with **FastAPI**, **Pydantic V2**, and **SQLAlchemy 2.0 (Async)**.
+
+---
+
+## 🚀 Overview
+
+`ecom_foundation_core` provides a modular backbone for complex enterprise systems. It is an enterprise foundation platform with auth, billing, notifications, and workflows, modularizing Authentication, RBAC, Billing, and Auditing—allowing you to build new microservices in minutes instead of months. While originally designed for the Ordvel marketplace, it is currently the foundation for the **International Regulatory Management System (IRMS)**.
+
+### Core Modules
+
+- 🔑 **Auth**: JWT-based authentication, password hashing, and 2FA.
+- 🛡️ **RBAC**: Multi-role support with fine-grained permission enforcement.
+- 💳 **Billing**: Unified interface for Stripe and Paystack.
+- 📜 **Audit**: Automatic logging of database changes (INSERT/UPDATE/DELETE).
+- ⚙️ **Workflows**: Built-in Celery integration for asynchronous processing.
+
+---
+
+## 🛠️ Getting Started
+
+### Installation
+
+```bash
+pip install ecom-foundation-core
+```
+
+### Quick Start Example
+
+This is all you need to create a fully secure microservice using the foundation:
+
+```python
+from ecom_foundation_core.bootstrap import create_app, AppConfig
+from ecom_foundation_core.modules.common.database import create_async_engine
+
+# 1. Configuration
+config = AppConfig(
+    title="Order Service",
+    enable_auth=True,
+    enable_rbac=True
+)
+
+# 2. Initialize PostgreSQL
+db_engine = create_async_engine("postgresql+asyncpg://user:pass@localhost/db")
+
+# 3. Bootstrap
+app = create_app(config=config, db_engine=db_engine)
+```
+
+---
+
+## 📖 In-Depth Guides
+
+We have provided step-by-step guides for every part of the system:
+
+1.  **[Getting Started](./docs/getting-started.md)**: Standard installation and basic usage.
+2.  **[Database & Migrations](./docs/database-and-migrations.md)**: Connecting to Postgres and managing migrations with Alembic.
+3.  **[Customizing Models](./docs/customizing-models.md)**: How to add your own fields and models, and how to use the `AuditableMixin`.
+4.  **[Example Application](./examples/fastapi_app.py)**: A standalone, runnable FastAPI application demonstrating all features.
+
+---
+
+## 🧬 Extending the System
+
+The foundation is designed to be personalized. You can easily extend internal models by inheriting from `Base`:
+
+```python
+from ecom_foundation_core.modules.common.database import Base
+from ecom_foundation_core.modules.audit.mixins import AuditableMixin
+
+class Product(Base, AuditableMixin):
+    __tablename__ = "products"
+    name: Mapped[str] = mapped_column(String(255))
+    price: Mapped[int] = mapped_column(Integer)
+```
+
+Adding this model to your application's `metadata` will automatically allow you to manage it via migrations and track it with the Audit system.
+
+---
+
+## 🧪 Testing
+
+The foundation comes with a robust test suite in Docker for maximum reliability:
+
+```bash
+docker compose -f docker-compose.test.yml up --build
+```
+
+---
+
+## 📄 License
+
+e-com services limited. All rights reserved.

ecom_foundation_core-0.1.0/README.md

@@ -0,0 +1,94 @@
+# E-Com Foundation Core
+
+A production-ready foundation for high-performance enterprise microservices. Built with **FastAPI**, **Pydantic V2**, and **SQLAlchemy 2.0 (Async)**.
+
+---
+
+## 🚀 Overview
+
+`ecom_foundation_core` provides a modular backbone for complex enterprise systems. It is an enterprise foundation platform with auth, billing, notifications, and workflows, modularizing Authentication, RBAC, Billing, and Auditing—allowing you to build new microservices in minutes instead of months. While originally designed for the Ordvel marketplace, it is currently the foundation for the **International Regulatory Management System (IRMS)**.
+
+### Core Modules
+
+- 🔑 **Auth**: JWT-based authentication, password hashing, and 2FA.
+- 🛡️ **RBAC**: Multi-role support with fine-grained permission enforcement.
+- 💳 **Billing**: Unified interface for Stripe and Paystack.
+- 📜 **Audit**: Automatic logging of database changes (INSERT/UPDATE/DELETE).
+- ⚙️ **Workflows**: Built-in Celery integration for asynchronous processing.
+
+---
+
+## 🛠️ Getting Started
+
+### Installation
+
+```bash
+pip install ecom-foundation-core
+```
+
+### Quick Start Example
+
+This is all you need to create a fully secure microservice using the foundation:
+
+```python
+from ecom_foundation_core.bootstrap import create_app, AppConfig
+from ecom_foundation_core.modules.common.database import create_async_engine
+
+# 1. Configuration
+config = AppConfig(
+    title="Order Service",
+    enable_auth=True,
+    enable_rbac=True
+)
+
+# 2. Initialize PostgreSQL
+db_engine = create_async_engine("postgresql+asyncpg://user:pass@localhost/db")
+
+# 3. Bootstrap
+app = create_app(config=config, db_engine=db_engine)
+```
+
+---
+
+## 📖 In-Depth Guides
+
+We have provided step-by-step guides for every part of the system:
+
+1.  **[Getting Started](./docs/getting-started.md)**: Standard installation and basic usage.
+2.  **[Database & Migrations](./docs/database-and-migrations.md)**: Connecting to Postgres and managing migrations with Alembic.
+3.  **[Customizing Models](./docs/customizing-models.md)**: How to add your own fields and models, and how to use the `AuditableMixin`.
+4.  **[Example Application](./examples/fastapi_app.py)**: A standalone, runnable FastAPI application demonstrating all features.
+
+---
+
+## 🧬 Extending the System
+
+The foundation is designed to be personalized. You can easily extend internal models by inheriting from `Base`:
+
+```python
+from ecom_foundation_core.modules.common.database import Base
+from ecom_foundation_core.modules.audit.mixins import AuditableMixin
+
+class Product(Base, AuditableMixin):
+    __tablename__ = "products"
+    name: Mapped[str] = mapped_column(String(255))
+    price: Mapped[int] = mapped_column(Integer)
+```
+
+Adding this model to your application's `metadata` will automatically allow you to manage it via migrations and track it with the Audit system.
+
+---
+
+## 🧪 Testing
+
+The foundation comes with a robust test suite in Docker for maximum reliability:
+
+```bash
+docker compose -f docker-compose.test.yml up --build
+```
+
+---
+
+## 📄 License
+
+e-com services limited. All rights reserved.

ecom_foundation_core-0.1.0/docker-compose.test.yml

@@ -0,0 +1,13 @@
+services:
+  test_suite:
+    build:
+      context: .
+      dockerfile: Dockerfile.test
+    volumes:
+      - .:/app
+    environment:
+      PYTHONPATH: /app/src
+      DATABASE_URL: "sqlite+aiosqlite:///:memory:"
+      REDIS_URL: "redis://localhost:6379/0"
+      CELERY_BROKER_URL: "redis://localhost:6379/0"
+      CELERY_RESULT_BACKEND: "redis://localhost:6379/0"