boostapi 0.1.0__tar.gz

boostapi-0.1.0/.env.example

@@ -0,0 +1,24 @@
+# ─── Database ──────────────────────────────────────────────
+POSTGRES_SERVER=localhost
+POSTGRES_PORT=5432
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=password
+POSTGRES_DB=boostapi
+DATABASE_URL=postgresql+asyncpg://postgres:password@localhost:5432/boostapi
+
+# ─── Redis ─────────────────────────────────────────────────
+REDIS_URL=redis://localhost:6379
+REDIS_CACHE_TTL=300
+
+# ─── Auth ──────────────────────────────────────────────────
+# IMPORTANT: Change this to a strong random key in production!
+# Generate with: python -c "import secrets; print(secrets.token_hex(32))"
+SECRET_KEY=your-super-secret-key-change-in-production
+ACCESS_TOKEN_EXPIRE_MINUTES=30
+ALGORITHM=HS256
+
+# ─── Application ───────────────────────────────────────────
+PROJECT_NAME=BoostAPI
+ENV=development
+LOG_LEVEL=DEBUG
+CORS_ORIGINS=["http://localhost:3000","http://localhost:8000"]

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

@@ -0,0 +1,100 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main]
+
+env:
+  PYTHON_VERSION: "3.11"
+
+jobs:
+  lint:
+    name: Lint & Type Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: pip
+
+      - name: Install dev dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run Ruff (linter)
+        run: ruff check src/ tests/
+
+      - name: Run Black (formatter check)
+        run: black --check src/ tests/
+
+      - name: Run MyPy (type checker)
+        run: mypy src/boostapi
+
+  test:
+    name: Tests (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    services:
+      postgres:
+        image: pgvector/pgvector:pg16
+        env:
+          POSTGRES_DB: boostapi_test
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+      redis:
+        image: redis:7-alpine
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests with coverage
+        env:
+          DATABASE_URL: postgresql+asyncpg://postgres:password@localhost:5432/boostapi_test
+          REDIS_URL: redis://localhost:6379
+          SECRET_KEY: ci-test-secret-key
+          ENV: test
+        run: |
+          pytest tests/ \
+            --cov=src/boostapi \
+            --cov-report=xml \
+            --cov-report=term-missing \
+            --cov-fail-under=80 \
+            -v
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          flags: py${{ matrix.python-version }}
+          token: ${{ secrets.CODECOV_TOKEN }}

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

@@ -0,0 +1,92 @@
+name: Release to PyPI
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: write
+  id-token: write  # Trusted publishing
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Full history for changelog
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+
+      - name: Install build tools
+        run: pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check build artifacts
+        run: twine check dist/*
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    runs-on: ubuntu-latest
+    needs: build
+    environment: testpypi
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [build, publish-testpypi]
+    environment: pypi
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    needs: publish-pypi
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+          fail_on_unmatched_files: true

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

@@ -0,0 +1,35 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+        args: ["--maxkb=1000"]
+      - id: check-merge-conflict
+      - id: debug-statements
+
+  - repo: https://github.com/psf/black
+    rev: 24.8.0
+    hooks:
+      - id: black
+        language_version: python3
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.2
+    hooks:
+      - id: mypy
+        additional_dependencies: [
+          "pydantic>=2.8",
+          "pydantic-settings>=2.8",
+          "types-passlib",
+        ]
+        args: ["--ignore-missing-imports"]

boostapi-0.1.0/Dockerfile

@@ -0,0 +1,41 @@
+# ── Build stage ───────────────────────────────────────────────────────────────
+FROM python:3.11-slim AS builder
+
+WORKDIR /app
+
+# Install build tools
+RUN pip install --no-cache-dir build hatchling
+
+COPY pyproject.toml README.md ./
+COPY src/ src/
+
+RUN python -m build --wheel --outdir /dist
+
+
+# ── Runtime stage ─────────────────────────────────────────────────────────────
+FROM python:3.11-slim
+
+WORKDIR /app
+
+# Create non-root user
+RUN addgroup --system boostapi && adduser --system --group boostapi
+
+# Install runtime dependencies only
+COPY --from=builder /dist/*.whl /tmp/
+RUN pip install --no-cache-dir /tmp/*.whl && rm /tmp/*.whl
+
+# Copy alembic config
+COPY alembic.ini ./
+COPY src/boostapi/migrations/ src/boostapi/migrations/
+
+# Create logs directory
+RUN mkdir -p logs && chown -R boostapi:boostapi logs
+
+USER boostapi
+
+EXPOSE 8000
+
+HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
+    CMD python -c "import httpx; httpx.get('http://localhost:8000/api/v1/health/ping')" || exit 1
+
+CMD ["uvicorn", "boostapi.app.main:app", "--host", "0.0.0.0", "--port", "8000", "--workers", "4"]

boostapi-0.1.0/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.4
+Name: boostapi
+Version: 0.1.0
+Summary: Production FastAPI starter toolkit with Redis, SQLAlchemy, JWT Auth, and CLI scaffolding
+Project-URL: Homepage, https://github.com/dhinakaran/boostapi
+Project-URL: Documentation, https://boostapi.readthedocs.io
+Project-URL: Repository, https://github.com/dhinakaran/boostapi
+Project-URL: Bug Tracker, https://github.com/dhinakaran/boostapi/issues
+Project-URL: Changelog, https://github.com/dhinakaran/boostapi/blob/main/CHANGELOG.md
+Author-email: Dhinakaran <dhinakaranthangaraj198@gmail.com>
+License: MIT
+Keywords: async,embeddings,fastapi,nlp,pgvector,postgresql,redis,semantic-search,sqlalchemy,vector-search
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: alembic>=1.13.0
+Requires-Dist: asyncpg>=0.29.0
+Requires-Dist: click>=8.1.0
+Requires-Dist: fastapi>=0.115.0
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: passlib[bcrypt]>=1.7.4
+Requires-Dist: pydantic-settings>=2.8.0
+Requires-Dist: python-jose[cryptography]>=3.3.0
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: redis[hiredis]>=5.0.0
+Requires-Dist: sqlalchemy[asyncio]>=2.0.0
+Requires-Dist: uvicorn[standard]>=0.30.0
+Provides-Extra: dev
+Requires-Dist: aiosqlite>=0.20.0; extra == 'dev'
+Requires-Dist: black>=24.0; extra == 'dev'
+Requires-Dist: httpx>=0.27; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pre-commit>=3.7.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6.0; extra == 'dev'
+Requires-Dist: types-passlib>=1.7.7; extra == 'dev'
+Provides-Extra: docker
+Requires-Dist: docker>=7.0.0; extra == 'docker'
+Provides-Extra: ml
+Requires-Dist: numpy>=1.26.0; extra == 'ml'
+Requires-Dist: sentence-transformers>=3.0.0; extra == 'ml'
+Description-Content-Type: text/markdown
+
+# 🛠️ BoostAPI
+
+<p align="center">
+  <strong>Production-ready FastAPI starter toolkit with Redis caching, JWT Auth & CLI scaffolding</strong>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/boostapi/"><img src="https://img.shields.io/pypi/v/boostapi?color=blue&logo=pypi&logoColor=white" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/boostapi/"><img src="https://img.shields.io/pypi/pyversions/boostapi?logo=python&logoColor=white" alt="Python versions"></a>
+  <a href="https://github.com/dhinakaran/boostapi/actions"><img src="https://img.shields.io/github/actions/workflow/status/dhinakaran/boostapi/ci.yml?label=CI&logo=github" alt="CI"></a>
+  <a href="https://codecov.io/gh/dhinakaran/boostapi"><img src="https://img.shields.io/codecov/c/github/dhinakaran/boostapi?logo=codecov" alt="Coverage"></a>
+  <a href="https://github.com/dhinakaran/boostapi/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green" alt="MIT License"></a>
+  <a href="https://github.com/dhinakaran/boostapi"><img src="https://img.shields.io/github/stars/dhinakaran/boostapi?style=flat&logo=github" alt="GitHub Stars"></a>
+</p>
+
+---
+
+## ✨ Features
+
+| Feature | Details |
+|---|---|
+| ⚡ **Redis Caching** | Built-in caching templates for instant responses |
+| 🔐 **JWT Auth** | Secure authentication with refresh tokens built-in |
+| 🗃️ **Async SQLAlchemy** | asyncpg driver, connection pooling, Alembic migrations |
+| 🛠️ **CLI Scaffolding** | `boostapi quickstart myapp` → full project in seconds |
+| 📦 **Zero-Config** | Works out of the box with sane defaults |
+| 🚀 **Production-Grade** | Loguru logging, CORS, rate limiting, OpenAPI docs |
+
+---
+
+## ⚡ 2-Minute Quickstart
+
+### Option A: Scaffold a New Project
+
+```bash
+# Install BoostAPI
+pip install boostapi
+
+# Scaffold a complete web application
+boostapi quickstart my-app
+cd my-app
+
+# Start dependencies (PostgreSQL + Redis)
+docker compose up -d
+
+# Run migrations & start server
+alembic upgrade head
+uvicorn app.main:app --reload
+```
+
+Open http://localhost:8000/docs — your API is live! 🎉
+
+### Option B: Embed in Your App
+
+```python
+# myapp.py
+from boostapi import create_app
+
+app = create_app()
+# uvicorn myapp:app --reload
+```
+
+### Option C: Custom Settings
+
+```python
+from boostapi import create_app
+from boostapi.app.core.config import Settings
+
+app = create_app(settings=Settings(
+    POSTGRES_DB="mydb",
+    REDIS_URL="redis://myredis:6379",
+    SECRET_KEY="super-secret-change-me",
+))
+```
+
+---
+
+## 🔌 API Reference
+
+### Authentication
+
+```bash
+# Login
+curl -X POST http://localhost:8000/api/v1/auth/login \
+  -H "Content-Type: application/json" \
+  -d '{"username": "admin", "password": "secret"}'
+
+# Returns:
+# {"access_token": "eyJ...", "token_type": "bearer"}
+```
+
+### Health Check
+
+```bash
+curl http://localhost:8000/api/v1/health/
+# {"status": "healthy", "version": "0.1.0", "db": "ok", "redis": "ok"}
+```
+
+---
+
+## 🐳 Docker Compose
+
+BoostAPI ships with a production-ready `docker-compose.yml`:
+
+```yaml
+# Included automatically via `boostapi quickstart`
+services:
+  db:    # postgres:16-alpine
+  redis: # redis:7-alpine
+  app:   # your FastAPI app
+```
+
+---
+
+## ⚙️ Configuration
+
+All settings are configurable via environment variables or `.env` file:
+
+| Variable | Default | Description |
+|---|---|---|
+| `POSTGRES_SERVER` | `localhost` | PostgreSQL host |
+| `POSTGRES_PORT` | `5432` | PostgreSQL port |
+| `POSTGRES_USER` | `postgres` | DB username |
+| `POSTGRES_PASSWORD` | `password` | DB password |
+| `POSTGRES_DB` | `boostapi` | Database name |
+| `REDIS_URL` | `redis://localhost:6379` | Redis connection URL |
+| `SECRET_KEY` | *(change me)* | JWT signing key |
+| `ACCESS_TOKEN_EXPIRE_MINUTES` | `30` | Token TTL (minutes) |
+
+---
+
+## 🧪 Testing
+
+```bash
+pip install boostapi[dev]
+pytest --cov=boostapi
+```
+
+---
+
+## 🚀 Deployment
+
+### Render / Fly.io
+
+```bash
+# Set environment variables in your hosting dashboard
+# then:
+uvicorn boostapi.app.main:app --host 0.0.0.0 --port $PORT
+```
+
+### Docker
+
+```bash
+docker build -t my-app .
+docker compose up
+```
+
+### Publish to PyPI
+
+```bash
+pip install build twine
+python -m build
+twine upload dist/*
+```
+
+---
+
+## 🏗️ Project Structure
+
+```
+my-app/                        # generated by `boostapi quickstart`
+├── app/
+│   ├── main.py                # create_app() entry point
+│   ├── api/endpoints/         # auth, health, etc.
+│   ├── core/                  # config, security
+│   ├── db/                    # models, migrations
+│   └── services/              # business logic
+├── tests/                     # pytest suite (90%+ coverage)
+├── docker-compose.yml
+├── alembic.ini
+└── .env
+```
+
+---
+
+## 📄 License
+
+MIT © [Dhinakaran](https://github.com/dheena731)