python-flashapi 0.1.0__py3-none-any.whl

python_flashapi-0.1.0.dist-info/METADATA

@@ -0,0 +1,259 @@
+Metadata-Version: 2.4
+Name: python-flashapi
+Version: 0.1.0
+Summary: Define your models. FlashAPI does the rest.
+Project-URL: Homepage, https://github.com/flashapi/flashapi
+Project-URL: Documentation, https://flashapi.dev
+Project-URL: Repository, https://github.com/flashapi/flashapi
+Author: FlashAPI Contributors
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,automatic,crud,django,fastapi,flask,rest
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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 :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Provides-Extra: all
+Requires-Dist: django>=4.2; extra == 'all'
+Requires-Dist: fastapi>=0.100.0; extra == 'all'
+Requires-Dist: flask>=2.3.0; extra == 'all'
+Requires-Dist: uvicorn>=0.20.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: httpx; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: django
+Requires-Dist: django>=4.2; extra == 'django'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.100.0; extra == 'fastapi'
+Requires-Dist: pydantic>=2.0; extra == 'fastapi'
+Requires-Dist: uvicorn>=0.20.0; extra == 'fastapi'
+Provides-Extra: flask
+Requires-Dist: flask>=2.3.0; extra == 'flask'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="docs/logo.svg" alt="FlashAPI" width="400">
+</p>
+
+<p align="center">
+  <strong>Define your models. FlashAPI does the rest.</strong>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/flashapi/"><img src="https://img.shields.io/pypi/v/flashapi?color=blue" alt="PyPI version"></a>
+  <a href="https://github.com/flashapi/flashapi/actions/workflows/ci.yml"><img src="https://github.com/flashapi/flashapi/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://pypi.org/project/flashapi/"><img src="https://img.shields.io/pypi/pyversions/flashapi" alt="Python versions"></a>
+  <a href="https://github.com/flashapi/flashapi/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green" alt="License"></a>
+</p>
+
+<p align="center">
+  <a href="#installation">Installation</a> &bull;
+  <a href="#quick-start">Quick Start</a> &bull;
+  <a href="docs/integration.md">Docs</a> &bull;
+  <a href="CHANGELOG.md">Changelog</a>
+</p>
+
+---
+
+FlashAPI generates a full REST API with CRUD, pagination, filtering, sorting, full-text search, relations, and interactive documentation from your existing models — in one line.
+
+---
+
+## Documentation
+
+| Doc | Description |
+|-----|-------------|
+| **[Integration Guide](docs/integration.md)** | Where to put FlashAPI in your project, new vs existing project, all 3 frameworks |
+| **[Features](docs/features.md)** | CRUD, pagination, filtering, sorting, search — detailed usage |
+| **[Relations](docs/relations.md)** | Nested routes, expand, how relations are detected |
+| **[Customization](docs/customization.md)** | Model wrapper, readonly, exclude, only, plural, response format, database |
+| **[Authentication](docs/authentication.md)** | How to protect endpoints (Django middleware, FastAPI deps, Flask before_request) |
+| **[Custom Logic](docs/custom-logic.md)** | How FlashAPI coexists with your business logic, when to use what |
+| **[Framework Notes](docs/framework-notes.md)** | Django, FastAPI, Flask specifics (serialization, URLs, field behavior) |
+| **[Full Examples](docs/examples.md)** | E-commerce, school, restaurant, blog, SaaS, minimal todo |
+
+---
+
+## Installation
+
+```bash
+pip install flashapi[fastapi]   # or flashapi[django] or flashapi[flask] or flashapi[all]
+```
+
+---
+
+## Quick Start
+
+### FastAPI (new project)
+
+```python
+# main.py
+from pydantic import BaseModel
+from flashapi.fastapi import FlashAPI
+
+class Product(BaseModel):
+    name: str
+    price: float
+    in_stock: bool = True
+
+app = FlashAPI(models=[Product]).app
+```
+
+```bash
+uvicorn main:app --reload
+# Open http://localhost:8000/docs
+```
+
+### FastAPI (existing project)
+
+```python
+# main.py — you already have app = FastAPI(...)
+from fastapi import FastAPI
+from flashapi.fastapi import FlashAPI
+from models import Product, Order
+
+app = FastAPI(title="My App")
+
+# Your existing routes stay untouched
+@app.get("/health")
+async def health():
+    return {"ok": True}
+
+# Mount FlashAPI under /api
+flash = FlashAPI(models=[Product, Order])
+app.mount("/api", flash.app)
+```
+
+See [Integration Guide](docs/integration.md) for all patterns (Option A/B/C).
+
+### Django
+
+```python
+# urls.py
+from django.urls import path, include
+from flashapi.django import generate_urls
+from myapp.models import Product, Order, Customer
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+    path("api/", include(generate_urls(models=[Product, Order, Customer]))),
+]
+```
+
+Open `http://localhost:8000/api/docs/` for Swagger UI.
+
+### Flask
+
+```python
+# app.py
+from flask import Flask
+from flashapi.flask import register_models
+from models import Product, Order
+
+app = Flask(__name__)
+register_models(app, models=[Product, Order])
+```
+
+Open `http://localhost:5000/docs` for Swagger UI.
+
+---
+
+## What you get
+
+For every model, FlashAPI generates:
+
+```
+GET    /{plural}/           → List (paginated, filterable, sortable, searchable)
+POST   /{plural}/           → Create
+GET    /{plural}/{id}/      → Read
+PUT    /{plural}/{id}/      → Update
+DELETE /{plural}/{id}/      → Delete
+GET    /{parent}/{id}/{children}/  → Nested list (auto-detected relations)
+```
+
+Plus: `?expand=relation` to inline related objects, and Swagger UI docs.
+
+---
+
+## Model support
+
+| Type | Detection | Storage |
+|------|-----------|---------|
+| Django Model | `_meta` attribute | Django ORM (your DB) |
+| SQLAlchemy | `__table__` attribute | Your SQLAlchemy engine |
+| Pydantic | `model_fields` attribute | Auto SQLite |
+| dataclass | `@dataclass` | Auto SQLite |
+
+---
+
+## Customization
+
+```python
+from flashapi import Model
+
+FlashAPI(models=[
+    Product,                               # Full CRUD
+    Model(Order, exclude=["delete"]),      # No delete
+    Model(Config, readonly=True),          # GET only
+    Model(Log, only=["list"]),             # List only
+    Model(Animal, plural="animaux"),       # Custom plural
+])
+```
+
+See [Customization docs](docs/customization.md) for all options.
+
+---
+
+## Authentication
+
+FlashAPI does NOT handle auth. You protect routes using your framework's standard mechanisms:
+
+- **Django**: middleware ([example](docs/authentication.md#django-middleware))
+- **FastAPI**: dependencies / middleware ([example](docs/authentication.md#fastapi-dependency-injection))
+- **Flask**: `before_request` ([example](docs/authentication.md#flask-before_request))
+
+See [Authentication docs](docs/authentication.md) for full examples including RBAC, JWT, API keys.
+
+---
+
+## Custom business logic
+
+FlashAPI does not interfere with your project. Add custom endpoints alongside:
+
+```python
+# FlashAPI handles CRUD
+flash = FlashAPI(models=[Product, Order])
+app = flash.app
+
+# You handle business logic
+@app.post("/checkout")
+async def checkout(request):
+    # Payment, emails, inventory...
+    return {"order_id": 42}
+```
+
+See [Custom Logic docs](docs/custom-logic.md) for patterns and decision guide.
+
+---
+
+## Philosophy
+
+- **FlashAPI handles CRUD, you handle business logic.** No black magic, no monkey-patching.
+- **Zero intrusion.** Does not modify your models, migrations, or existing code.
+- **Composable.** Use it for 2 models or 20. Mix with custom endpoints freely.
+- **No opinion on auth.** Your project, your rules.
+- **Framework-native.** Generates standard routes. No lock-in, no proprietary runtime.
+
+---
+
+## License
+
+MIT

python_flashapi-0.1.0.dist-info/RECORD

@@ -0,0 +1,39 @@
+flashapi/__init__.py,sha256=0ktyPPBJUvxjAto0CHzDGPZEJ2pI0mgMZ_dTM15mgRI,290
+flashapi/django.py,sha256=wsKMGpFNNSnSjV-TaI3H07SLwJnff7bD6SV9M1WxKwE,140
+flashapi/fastapi.py,sha256=pW4UYDD1IFBJZPcynLmA468hb_oPPbhn8ClRXxNf2Dc,132
+flashapi/flask.py,sha256=ZUxdHO3i2vgVC2gjhkHIZpQVyJ1fmrgBsdWMreWrKM0,142
+flashapi/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+flashapi/adapters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+flashapi/adapters/base.py,sha256=qv3UZPePMZqLERJqMsdugbe_xdB2rkYOUwx9E7NgiFo,304
+flashapi/adapters/django.py,sha256=XERqdgNjQsgH2gh_TuZiQjn-fdIpvsrJQh_w-awkR28,6907
+flashapi/adapters/fastapi.py,sha256=sVRkgA9efsL9dRmVlLt3tRRhCfEOjh9G1_HSCScF2Kc,12541
+flashapi/adapters/flask.py,sha256=KjG8cl6mhoeydWq4xntPqcusRpdqqTxQBXlEe_lJfOo,9412
+flashapi/core/__init__.py,sha256=RsBTdHf6vwSFH50BJBodogK_MJNAOv4JHNnPgHNBpYw,177
+flashapi/core/custom_routes.py,sha256=IOc4Nn_eTqrzPA_LLbYyuRnfDpKcCyiE5Xz5njtdFwc,8428
+flashapi/core/pluralize.py,sha256=3jzIRO-50cOZs8kt-aCG26QbaDedF8Egp_sc_EGhqL8,2486
+flashapi/core/relations.py,sha256=ZeIv5JEs9tY6aP4W3iVrtRixRn2hJVvUpe7VGXcfFvw,2307
+flashapi/core/response.py,sha256=6UUWR6IflTuISALu_P_7aVEgoR68iG5c_eOJ8Q6_8Ng,885
+flashapi/core/schema.py,sha256=6FbSwBn08BGdxaR3QAFel4l729ScpOsdxRPGZ1sYN_U,2066
+flashapi/docs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+flashapi/docs/openapi.py,sha256=cYy0q5hEyEF6CvaFEd_C5XNUQPAAaloIxzd39kIDTOw,8281
+flashapi/features/__init__.py,sha256=-0rOQ6vGvK3dWthPfcPHgZjs17RgGQ_E6QJw6lXB7lQ,286
+flashapi/features/filtering.py,sha256=XJC-5QmVLXvn6C2nhvLFWnUtChz4jvwHPFD5TI78BHQ,842
+flashapi/features/pagination.py,sha256=TJsL3Byofaaa4eH6vgGP1TeWDJ4VmNcUjSXPVKiWXyw,516
+flashapi/features/search.py,sha256=yLOPYNOPqrcxeES0xNxooDv4yVOf99HihwlWflfG1N4,636
+flashapi/features/sorting.py,sha256=fgsNMeN2AEzHROgWpl9gOlUOhccWePbzhJcfywnepTI,527
+flashapi/inspectors/__init__.py,sha256=OUAru4OtHLbz0K1IGgttVBNmC_5zX45FCpHmDW1wr0I,85
+flashapi/inspectors/base.py,sha256=ADYlfZVhIC_dvj3cB7hnWgI69xtmp8n7Zs0_IfT7p-Y,269
+flashapi/inspectors/dataclass.py,sha256=MgD468p339Y_YgSYtMiYntl7WTOQVwM5lYUbfbbZr1o,1378
+flashapi/inspectors/detect.py,sha256=3kNN4UGbk8232_ctFpQmY_ExELZDeIQ3xMhF8u6yIyk,1585
+flashapi/inspectors/django.py,sha256=z1cvHhY4eDHzhhhEhjnKqOBtOz7-2s6WI3emEmqnqU4,3205
+flashapi/inspectors/pydantic.py,sha256=cIvzqRS8ovM-N3LSmXQRBQ5-of2-OTu9mnupsufyMso,2996
+flashapi/inspectors/sqlalchemy.py,sha256=zCY7v-ugvDT1vkUlaVbMC3J1norVDtZbqkMQt7EqSGw,2809
+flashapi/storage/__init__.py,sha256=ykEwUTl-C9sP0eHYIf1w3D9iuPVnO176Pm-muXPUzAI,130
+flashapi/storage/auto.py,sha256=7tqlUZ_327jPpzZbjcbv4yCYUN-jZthhLJCkjPXHKPE,3947
+flashapi/storage/base.py,sha256=b5gBj7j6DdY7AXrHnZ0Fj1o0SLND4z4lXsWzjNyIMhc,680
+flashapi/storage/orm.py,sha256=2NlF8JK69R0bR1UiZe6YcUM7TJGB5oYRvcviwiRJ7nY,2919
+flashapi/storage/sqlalchemy.py,sha256=o1rK2GmGvynj_zVdgvAHFqgWykt5Pe2GyKhuOm0bxb0,4697
+python_flashapi-0.1.0.dist-info/METADATA,sha256=Bqwqbtqzd34-jdOk5YA17bLniM90o16-jbMIisQ5P54,7939
+python_flashapi-0.1.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+python_flashapi-0.1.0.dist-info/licenses/LICENSE,sha256=w0eWMxyBEZ3WUTFwSIdU-42zIv0zJC5dcwH2XUXrrds,1099
+python_flashapi-0.1.0.dist-info/RECORD,,

python_flashapi-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

python_flashapi-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FlashAPI Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.