nene2-python 1.0.0__py3-none-any.whl

nene2_python-1.0.0.dist-info/METADATA

@@ -0,0 +1,211 @@
+Metadata-Version: 2.4
+Name: nene2-python
+Version: 1.0.0
+Summary: NENE2 Python — minimal API framework following NENE2's design philosophy
+Project-URL: Homepage, https://github.com/hideyukiMORI/nene2-python
+Project-URL: Repository, https://github.com/hideyukiMORI/nene2-python
+Project-URL: Documentation, https://github.com/hideyukiMORI/nene2-python/tree/main/docs
+Project-URL: Bug Tracker, https://github.com/hideyukiMORI/nene2-python/issues
+Author-email: hideyukiMORI <info.xion.cc@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: api,clean-architecture,fastapi,framework,mcp,pydantic,sqlalchemy
+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
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: alembic>=1.18.4
+Requires-Dist: fastapi>=0.115
+Requires-Dist: httpx>=0.27
+Requires-Dist: mcp>=1.0
+Requires-Dist: pydantic-settings>=2.6
+Requires-Dist: pydantic>=2.9
+Requires-Dist: python-multipart>=0.0.12
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: sqlalchemy>=2.0.49
+Requires-Dist: structlog>=24.0
+Requires-Dist: uvicorn[standard]>=0.32
+Provides-Extra: dev
+Requires-Dist: httpx>=0.27; extra == 'dev'
+Requires-Dist: mypy>=1.13; extra == 'dev'
+Requires-Dist: pip-audit>=2.7; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0; extra == 'dev'
+Requires-Dist: pytest>=8.3; extra == 'dev'
+Requires-Dist: ruff>=0.9; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# nene2-python
+
+A Python reference framework implementing the [NENE2](https://github.com/hideyukiMORI/NENE2) design philosophy — clean architecture, security-first, and AI-readable code.
+
+[![CI](https://github.com/hideyukiMORI/nene2-python/actions/workflows/ci.yml/badge.svg)](https://github.com/hideyukiMORI/nene2-python/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/badge/python-3.12%2B-blue)](https://www.python.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+---
+
+## Features
+
+- **FastAPI + Pydantic v2** — modern Python API stack with automatic OpenAPI docs
+- **Clean Architecture** — UseCase / Domain layer fully decoupled from HTTP and DB
+- **`mypy --strict`** — equivalent to PHPStan level 8 type safety
+- **ruff** — lint and format in one tool (replaces flake8, isort, black, bandit)
+- **RFC 9457 Problem Details** — uniform error responses across all endpoints
+- **Bearer Token / API Key auth** — zero-config `LocalTokenVerifier`
+- **MCP support** — expose UseCases as AI agent tools via `LocalMcpServer`
+- **SQLAlchemy Core** — parameterised SQL without ORM overhead
+- **Security middleware** — CSP, X-Frame-Options, rate limiting, request size limit, CORS
+- **structlog** — structured JSON logging with request ID correlation
+
+---
+
+## Installation
+
+```bash
+pip install nene2-python
+# or
+uv add nene2-python
+```
+
+Requires Python 3.12+.
+
+---
+
+## Quick Start
+
+```python
+from fastapi import FastAPI
+from nene2.config import AppSettings
+from nene2.middleware import (
+    ErrorHandlerMiddleware,
+    RequestIdMiddleware,
+    SecurityHeadersMiddleware,
+    ThrottleMiddleware,
+)
+
+cfg = AppSettings()
+app = FastAPI()
+
+app.add_middleware(ErrorHandlerMiddleware, debug=cfg.app_debug)
+app.add_middleware(SecurityHeadersMiddleware)
+app.add_middleware(RequestIdMiddleware)
+app.add_middleware(ThrottleMiddleware, limit=cfg.throttle_limit, window=cfg.throttle_window)
+```
+
+### Define a domain
+
+```python
+from dataclasses import dataclass
+from abc import ABC, abstractmethod
+
+@dataclass(frozen=True, slots=True)
+class Note:
+    id: int
+    title: str
+    body: str
+
+class NoteRepositoryInterface(ABC):
+    @abstractmethod
+    def find_by_id(self, note_id: int) -> Note | None: ...
+
+@dataclass(frozen=True, slots=True)
+class GetNoteInput:
+    note_id: int
+
+class GetNoteUseCase:
+    def __init__(self, repository: NoteRepositoryInterface) -> None:
+        self._repository = repository
+
+    def execute(self, input_: GetNoteInput) -> Note:
+        note = self._repository.find_by_id(input_.note_id)
+        if note is None:
+            raise NoteNotFoundException(input_.note_id)
+        return note
+```
+
+### Wire to HTTP
+
+```python
+from fastapi import APIRouter
+from fastapi.responses import JSONResponse
+from nene2.http import problem_details_response
+
+router = APIRouter(prefix="/notes", tags=["notes"])
+
+@router.get("/{note_id}")
+async def get_note(note_id: int) -> JSONResponse:
+    note = get_use_case.execute(GetNoteInput(note_id))
+    return JSONResponse({"id": note.id, "title": note.title, "body": note.body})
+```
+
+See the full working example in [`src/example/`](src/example/).
+
+---
+
+## Development Commands
+
+```bash
+uv sync                         # install dependencies
+uv run pytest                   # run tests (coverage enforced at 80%)
+uv run mypy src/                # type check
+uv run ruff check src/ tests/   # lint
+uv run ruff format src/ tests/  # format
+uv run uvicorn src.example.app:app --reload --port 8080  # dev server
+```
+
+Full CI check (equivalent to GitHub Actions):
+
+```bash
+uv run pytest && \
+uv run mypy src/ && \
+uv run ruff check src/ tests/ && \
+uv run ruff format --check src/ tests/ && \
+uv run pip-audit
+```
+
+---
+
+## Framework Modules
+
+| Module | Purpose |
+|---|---|
+| `nene2.http` | `PaginationQueryParser`, `PaginationResponse`, `problem_details_response()` |
+| `nene2.middleware` | `ErrorHandlerMiddleware`, `SecurityHeadersMiddleware`, `RequestIdMiddleware`, `RequestLoggingMiddleware`, `RequestSizeLimitMiddleware`, `ThrottleMiddleware` |
+| `nene2.auth` | `BearerTokenMiddleware`, `ApiKeyAuthMiddleware`, `LocalTokenVerifier`, `TokenVerifierProtocol` |
+| `nene2.database` | `SqlAlchemyQueryExecutor`, `SqlAlchemyTransactionManager`, `DatabaseHealthCheck` |
+| `nene2.config` | `AppSettings` (pydantic-settings, reads from env / `.env`) |
+| `nene2.validation` | `ValidationException`, `ValidationError` |
+| `nene2.mcp` | `LocalMcpServer`, `HttpxMcpClient` |
+| `nene2.log` | `setup_logging()` (structlog, JSON in production) |
+| `nene2.use_case` | `UseCaseProtocol[I, O]`, `AsyncUseCaseProtocol[I, O]` |
+
+---
+
+## PHP NENE2 Correspondence
+
+| PHP | Python |
+|---|---|
+| `readonly class` | `dataclass(frozen=True, slots=True)` |
+| `PHPStan level 8` | `mypy --strict` |
+| `PHP-CS-Fixer` | `ruff format` |
+| `composer check` | `uv run pytest && mypy && ruff check && ruff format --check && pip-audit` |
+| `ValidationException` | `nene2.validation.ValidationException` |
+| `PaginationQueryParser` | `nene2.http.PaginationQueryParser` |
+| `ErrorHandlerMiddleware` | `nene2.middleware.ErrorHandlerMiddleware` |
+| `LocalMcpServer` | `nene2.mcp.LocalMcpServer` |
+
+---
+
+## Related
+
+- [NENE2 (PHP)](https://github.com/hideyukiMORI/NENE2) — PHP reference implementation
+- [Documentation](https://hideyukimori.github.io/nene2-python/) — full docs (Diátaxis structure)

nene2_python-1.0.0.dist-info/RECORD

@@ -0,0 +1,40 @@
+nene2/__init__.py,sha256=BbkkyxUGlvKbcfXFS6ZMO4y1SDwR7J1Zi0tK5C0Fm6A,46
+nene2/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nene2/auth/__init__.py,sha256=6CL-QYTo-QqqTTWdcICkavd7LOsx7LYKMWlU78sgcU0,478
+nene2/auth/api_key.py,sha256=lTvpwcfRT8mVS-iZk7VGU3hUtGK718XNfYoSDdzIHbk,1379
+nene2/auth/bearer_token.py,sha256=hUdgjmYPT1330q2kv0R4WPJmm0Fav5wDgvwT_5q8h7o,1822
+nene2/auth/exceptions.py,sha256=ksgMVCZhcI6C7TKOMZkNe3-G3VmYrNL66PsCf_uLUZM,240
+nene2/auth/interfaces.py,sha256=_wEZ7FmjMpqHVKNY_rS4__v61Kn4mZ2-dn_byP6jnU0,570
+nene2/auth/local_verifier.py,sha256=d7xLM3elJwm-i60Yb5mUJlVWlJRjoHTB9LqnxUaCDYs,588
+nene2/config/__init__.py,sha256=VAAqpJPW1bC1TtTLvkx5aFTC0d0cRPS71Z3dbcjk_Cg,139
+nene2/config/settings.py,sha256=LR5HwXHUumW0UZmZRAgXidvw_m71pKVMEakgOpH9sNo,2386
+nene2/database/__init__.py,sha256=9mwmvhG3sjlF9qDkfXrItZI1Sv_twgwfpmRdtRjKh2c,537
+nene2/database/exceptions.py,sha256=75X5b1Go9JT59KGRwn08pygJajecmGzpewodbBqzPUQ,142
+nene2/database/health.py,sha256=-WJ1OxOjll0mDPIAfoBtSxyiT-el76U8f7XT-Syl8xo,793
+nene2/database/interfaces.py,sha256=1uSV19Bq6VAQzQbiY5c-16XpslegB7P3uklhIHvudd8,1501
+nene2/database/sqlalchemy_executor.py,sha256=-s-NmRyDhEdQPYeYJvcf2BJWLpqDqcbH1QhsTDM3tzs,5078
+nene2/http/__init__.py,sha256=zRF4mrCD6582VHqtP6BhIiwFQQBrXzZ9SDFT2QaeOv8,440
+nene2/http/health.py,sha256=zYAeXkEWWCITFmza9u8yqcSkD2sJx7AGm650HhvU9Fs,496
+nene2/http/pagination.py,sha256=BmKyTcNBplQtGADYjqlSvWSGEih9bb3DG-rT_CyvOg8,2663
+nene2/http/problem_details.py,sha256=-a4E6OV0caigcETf9YBupPEhjlYvqLEwZdCux1ujhPI,874
+nene2/log/__init__.py,sha256=umsIJ2QH0d-CpnqEQCR0oWCjpe7wVoGYAYP35f1Nmbc,113
+nene2/log/setup.py,sha256=JZJ3EnUjN9XcC1BB03gbgk4R4cpOYgu7it487pLCIb0,1407
+nene2/mcp/__init__.py,sha256=KBJAAa2ewj5aAeUWzl-2DU-qujAb-EIyeCHG0U8FBjc,289
+nene2/mcp/http_client.py,sha256=bMG49qZJgZGZtucJuSzAA4WPmmynQ-tDYtCElBDRFoI,3092
+nene2/mcp/server.py,sha256=NJF5FOV5YoSS2IVwUonM0h4pYh2fINU18I7GqLmP8Wc,927
+nene2/middleware/__init__.py,sha256=_FLy_xggx6iHCeKxlrawX_Z0tiQqirwWIbTvi4ii4GE,672
+nene2/middleware/domain_exception.py,sha256=hnJhMaa9_p-Ptlh6BwjpDuyxFkDHeZSc5zy6I_ZuMW4,572
+nene2/middleware/error_handler.py,sha256=Ms4tEJED1-C2nIDoDG5Dm_bYk623oHa6D3zvS0d6kGQ,4166
+nene2/middleware/request_id.py,sha256=vj3H1ULai8EgzoCfaM-YIf-vUbMhSiGmnfuUDjSgdY0,1540
+nene2/middleware/request_logging.py,sha256=knmZV23HmmIJA73QIgpunfMi1bO8JttwwAGORju8UF0,1204
+nene2/middleware/request_size_limit.py,sha256=r1nuV7TOyJ6tFGFgjd1mS7xU0KHmSQv6gMV8Qp417lQ,1793
+nene2/middleware/security_headers.py,sha256=wZvQbqfD82ZmOgA3yBBRkAchR1YL3G0R8TnB-wbjP7A,1468
+nene2/middleware/throttle.py,sha256=jI3XCUDfitmaF-ACznXMhaq8KPdmdhL5wT3jAPs5dns,2633
+nene2/use_case/__init__.py,sha256=xwdFxHsjfPORSw6sq6dUN8JkEX6X2CHmO3stdpjUNOU,196
+nene2/use_case/protocols.py,sha256=F-R99vLad7XX6fHncTVBo5XLsKFsVceWqnE4QlSn9kg,710
+nene2/validation/__init__.py,sha256=Nj4dMx4Re3l57B0raFSUPQWeHHFMJbBQaQcuvDSbwiE,205
+nene2/validation/exceptions.py,sha256=qFaK-LAk1sNs90TV0mrQLvwNlfUruSohRqpqOaaG-lg,1036
+nene2_python-1.0.0.dist-info/METADATA,sha256=ZMDcaQqIqEj-pyekXLnIo47Yzxxbs3J_ybrUqHtV5bQ,7263
+nene2_python-1.0.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+nene2_python-1.0.0.dist-info/licenses/LICENSE,sha256=fzFjofg1algLQJI6DBIhxBDQTpry6HNLUcjrXMPTwIk,1069
+nene2_python-1.0.0.dist-info/RECORD,,

nene2_python-1.0.0.dist-info/WHEEL

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

nene2_python-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 hideyukiMORI
+
+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.