reroute 0.1.0__tar.gz

reroute-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 C B Sajan
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

reroute-0.1.0/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: reroute
+Version: 0.1.0
+Summary: File-based routing for Python backend frameworks (FastAPI, Flask)
+Home-page: https://github.com/cbsajan/reroute
+Author: C B Sajan
+Author-email: C B Sajan <cloud.ckhathri@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/cbsajan/reroute
+Project-URL: Repository, https://github.com/cbsajan/reroute
+Project-URL: Documentation, https://cbsajan.github.io/reroute-docs
+Keywords: fastapi,flask,routing,file-based,web-framework
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Framework :: FastAPI
+Classifier: Framework :: Flask
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0.0
+Requires-Dist: questionary>=2.0.0
+Requires-Dist: jinja2>=3.0.0
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.100.0; extra == "fastapi"
+Requires-Dist: uvicorn[standard]>=0.20.0; extra == "fastapi"
+Provides-Extra: flask
+Requires-Dist: flask>=2.0.0; extra == "flask"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# REROUTE
+
+**File-based routing for Python backends** - Inspired by Next.js, powered by FastAPI/Flask
+
+REROUTE brings the simplicity of file-based routing to Python backend development. Just create files in folders, and they automatically become API endpoints.
+
+## Features
+
+- **File-based Routing**: Folder structure maps directly to URL paths
+- **Class-based Routes**: Clean, organized route handlers with lifecycle hooks
+- **Parameter Injection**: FastAPI-style parameter extraction (Query, Path, Header, Body, etc.)
+- **Pydantic Models**: Generate data validation models with CLI
+- **Framework Adapters**: Works with FastAPI (Flask, Django support coming)
+- **Interactive CLI**: Next.js-style project scaffolding with beautiful prompts
+- **Code Generation**: Quickly generate routes, CRUD operations, models, and tests
+- **Environment Config**: .env file support with auto-loading
+- **Powerful Decorators**: Rate limiting, caching, validation, and more
+- **API Versioning**: Built-in support for base path prefixes (e.g., `/api/v1`)
+
+## Installation
+
+```bash
+pip install reroute
+```
+
+## Quick Start
+
+```bash
+# Create a new project
+reroute init myapi
+
+# Navigate to project
+cd myapi
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Run the server
+python main.py
+```
+
+Visit `http://localhost:7376/docs` for interactive API documentation.
+
+## Documentation
+
+📚 **[Complete Documentation](https://cbsajan.github.io/reroute-docs)** - Full guides, API reference, and examples
+
+Quick links:
+- [Getting Started](https://cbsajan.github.io/reroute-docs/getting-started/) - Installation and first route
+- [CLI Commands](https://cbsajan.github.io/reroute-docs/cli/commands/) - Complete CLI reference
+- [API Reference](https://cbsajan.github.io/reroute-docs/api/) - RouteBase, parameters, decorators, config
+- [Examples](https://cbsajan.github.io/reroute-docs/examples/) - CRUD, authentication, rate limiting, caching
+- [Contributing](CONTRIBUTING.md) - How to contribute to REROUTE
+
+## How It Works
+
+REROUTE uses your folder structure to create API routes. Each folder becomes a URL path, and each `page.py` file defines the route handlers.
+
+```
+app/routes/hello/page.py → /hello
+app/routes/users/page.py → /users
+app/routes/posts/page.py → /posts
+```
+
+**API Versioning with Base Path:**
+Instead of creating nested folders, use `API_BASE_PATH` in config:
+
+```python
+# config.py
+API_BASE_PATH = "/api/v1"
+```
+
+Now your routes are automatically prefixed:
+```
+app/routes/users/page.py → /api/v1/users
+app/routes/posts/page.py → /api/v1/posts
+```
+
+## Key Concepts
+
+### File-based Routing
+Your folder structure is your API structure. No manual route registration needed.
+
+### Class-based Routes
+Each route is a Python class with methods for HTTP verbs (get, post, put, delete, etc.).
+
+### Lifecycle Hooks
+Routes support `before_request`, `after_request`, and `on_error` hooks for common patterns.
+
+### Configuration
+Every project has a `config.py` file to customize server settings, routing behavior, and more.
+
+### API Versioning
+Use `API_BASE_PATH` to prefix all routes (e.g., `/api/v1`).
+
+## Framework Support
+
+- **FastAPI** - Fully supported with OpenAPI docs
+- **Flask** - Coming soon
+
+## License
+
+Apache License 2.0
+
+## Contributing
+
+We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## Support
+
+- **Documentation**: [https://cbsajan.github.io/reroute-docs](https://cbsajan.github.io/reroute-docs)
+- **Issues**: [GitHub Issues](https://github.com/cbsajan/reroute/issues)
+- **PyPI**: [pypi.org/project/reroute](https://pypi.org/project/reroute)
+
+---
+
+Built with by developers, for developers.

reroute-0.1.0/README.md

@@ -0,0 +1,117 @@
+# REROUTE
+
+**File-based routing for Python backends** - Inspired by Next.js, powered by FastAPI/Flask
+
+REROUTE brings the simplicity of file-based routing to Python backend development. Just create files in folders, and they automatically become API endpoints.
+
+## Features
+
+- **File-based Routing**: Folder structure maps directly to URL paths
+- **Class-based Routes**: Clean, organized route handlers with lifecycle hooks
+- **Parameter Injection**: FastAPI-style parameter extraction (Query, Path, Header, Body, etc.)
+- **Pydantic Models**: Generate data validation models with CLI
+- **Framework Adapters**: Works with FastAPI (Flask, Django support coming)
+- **Interactive CLI**: Next.js-style project scaffolding with beautiful prompts
+- **Code Generation**: Quickly generate routes, CRUD operations, models, and tests
+- **Environment Config**: .env file support with auto-loading
+- **Powerful Decorators**: Rate limiting, caching, validation, and more
+- **API Versioning**: Built-in support for base path prefixes (e.g., `/api/v1`)
+
+## Installation
+
+```bash
+pip install reroute
+```
+
+## Quick Start
+
+```bash
+# Create a new project
+reroute init myapi
+
+# Navigate to project
+cd myapi
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Run the server
+python main.py
+```
+
+Visit `http://localhost:7376/docs` for interactive API documentation.
+
+## Documentation
+
+📚 **[Complete Documentation](https://cbsajan.github.io/reroute-docs)** - Full guides, API reference, and examples
+
+Quick links:
+- [Getting Started](https://cbsajan.github.io/reroute-docs/getting-started/) - Installation and first route
+- [CLI Commands](https://cbsajan.github.io/reroute-docs/cli/commands/) - Complete CLI reference
+- [API Reference](https://cbsajan.github.io/reroute-docs/api/) - RouteBase, parameters, decorators, config
+- [Examples](https://cbsajan.github.io/reroute-docs/examples/) - CRUD, authentication, rate limiting, caching
+- [Contributing](CONTRIBUTING.md) - How to contribute to REROUTE
+
+## How It Works
+
+REROUTE uses your folder structure to create API routes. Each folder becomes a URL path, and each `page.py` file defines the route handlers.
+
+```
+app/routes/hello/page.py → /hello
+app/routes/users/page.py → /users
+app/routes/posts/page.py → /posts
+```
+
+**API Versioning with Base Path:**
+Instead of creating nested folders, use `API_BASE_PATH` in config:
+
+```python
+# config.py
+API_BASE_PATH = "/api/v1"
+```
+
+Now your routes are automatically prefixed:
+```
+app/routes/users/page.py → /api/v1/users
+app/routes/posts/page.py → /api/v1/posts
+```
+
+## Key Concepts
+
+### File-based Routing
+Your folder structure is your API structure. No manual route registration needed.
+
+### Class-based Routes
+Each route is a Python class with methods for HTTP verbs (get, post, put, delete, etc.).
+
+### Lifecycle Hooks
+Routes support `before_request`, `after_request`, and `on_error` hooks for common patterns.
+
+### Configuration
+Every project has a `config.py` file to customize server settings, routing behavior, and more.
+
+### API Versioning
+Use `API_BASE_PATH` to prefix all routes (e.g., `/api/v1`).
+
+## Framework Support
+
+- **FastAPI** - Fully supported with OpenAPI docs
+- **Flask** - Coming soon
+
+## License
+
+Apache License 2.0
+
+## Contributing
+
+We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## Support
+
+- **Documentation**: [https://cbsajan.github.io/reroute-docs](https://cbsajan.github.io/reroute-docs)
+- **Issues**: [GitHub Issues](https://github.com/cbsajan/reroute/issues)
+- **PyPI**: [pypi.org/project/reroute](https://pypi.org/project/reroute)
+
+---
+
+Built with by developers, for developers.

reroute-0.1.0/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "reroute"
+version = "0.1.0"
+description = "File-based routing for Python backend frameworks (FastAPI, Flask)"
+readme = "README.md"
+requires-python = ">=3.8"
+license = "Apache-2.0"
+authors = [
+    {name = "C B Sajan", email = "cloud.ckhathri@gmail.com"}
+]
+keywords = ["fastapi", "flask", "routing", "file-based", "web-framework"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Framework :: FastAPI",
+    "Framework :: Flask",
+]
+
+dependencies = [
+    "click>=8.0.0",
+    "questionary>=2.0.0",
+    "jinja2>=3.0.0",
+]
+
+[project.optional-dependencies]
+fastapi = ["fastapi>=0.100.0", "uvicorn[standard]>=0.20.0"]
+flask = ["flask>=2.0.0"]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-asyncio>=0.21.0",
+    "black>=23.0.0",
+    "ruff>=0.1.0",
+]
+
+[project.scripts]
+reroute = "reroute.cli.commands:cli"
+
+[project.urls]
+Homepage = "https://github.com/cbsajan/reroute"
+Repository = "https://github.com/cbsajan/reroute"
+Documentation = "https://cbsajan.github.io/reroute-docs"
+
+[tool.setuptools]
+packages = ["reroute", "reroute.core", "reroute.adapters", "reroute.cli", "reroute.cli.templates"]
+
+[tool.setuptools.package-data]
+"reroute.cli" = ["templates/*.j2"]

reroute-0.1.0/reroute/__init__.py

@@ -0,0 +1,49 @@
+"""
+REROUTE - The Modern Python Backend Framework
+
+A lightweight Python backend framework inspired by Angular CLI (generation),
+Next.js (folder routing), and FastAPI/Flask (underlying HTTP).
+
+Minimal Quick Start:
+    from fastapi import FastAPI
+    from reroute import RouteBase, FastAPIAdapter
+
+    app = FastAPI()
+    adapter = FastAPIAdapter(app, app_dir="./app")
+    adapter.register_routes()
+
+Full Import Guide:
+    # Core - minimal essentials
+    from reroute import RouteBase, Config, FastAPIAdapter, run_server
+
+    # Parameter injection
+    from reroute.params import Query, Body, Header, Path
+
+    # Decorators
+    from reroute.decorators import rate_limit, cache, requires
+
+    # Logging
+    from reroute.logging import get_logger
+"""
+
+__version__ = "0.1.0"
+
+# Core essentials for minimal usage
+from reroute.core.base import RouteBase
+from reroute.config import Config, DevConfig, ProdConfig
+from reroute.utils import run_server
+from reroute.adapters import FastAPIAdapter
+
+__all__ = [
+    # Core
+    "RouteBase",
+    "Config",
+    "DevConfig",
+    "ProdConfig",
+    # Adapters (for minimal setup)
+    "FastAPIAdapter",
+    # Utils (for minimal setup)
+    "run_server",
+    # Version
+    "__version__",
+]

reroute-0.1.0/reroute/__main__.py

@@ -0,0 +1,10 @@
+"""
+REROUTE CLI Entry Point
+
+Allows running the CLI with: python -m reroute
+"""
+
+from reroute.cli.commands import cli
+
+if __name__ == '__main__':
+    cli()

reroute-0.1.0/reroute/adapters/__init__.py

@@ -0,0 +1,9 @@
+"""
+REROUTE Adapters
+
+Framework adapters for FastAPI, Flask, etc.
+"""
+
+from reroute.adapters.fastapi import FastAPIAdapter
+
+__all__ = ["FastAPIAdapter"]