ryuuseigun 0.1.0__tar.gz

ryuuseigun-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Test
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+    branches: [master, main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[test]"
+
+      - name: Run tests
+        run: python -m pytest tests/ -v

ryuuseigun-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+.pytest_cache/
+.venv/
+.idea/
+dist/
+public/
+main.py

ryuuseigun-0.1.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 02/XX/2026
+
+## 0.1.0
+
+- Initial release

ryuuseigun-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 [yyyy] [name of copyright owner]
+
+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.

ryuuseigun-0.1.0/PKG-INFO

@@ -0,0 +1,296 @@
+Metadata-Version: 2.4
+Name: ryuuseigun
+Version: 0.1.0
+Summary: A lightweight, type-safe, async web framework inspired by Flask
+Project-URL: source, https://github.com/depthbomb/ryuuseigun
+Project-URL: documentation, https://github.com/depthbomb/ryuuseigun
+Project-URL: changelog, https://github.com/depthbomb/ryuuseigun/blob/master/CHANGELOG.md
+Author: depthbomb
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Provides-Extra: test
+Requires-Dist: pytest>=9.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# ☄️ Ryūseigun
+
+A lightweight, type-safe, async web framework inspired by [Flask.](https://flask.palletsprojects.com)
+
+---
+
+_Ryūseigun_ is deliberately minimal, embracing a “bring-your-own-X” philosophy. It provides just enough to give you 
+something that works and leaves plenty of room to do things how you want to.
+
+## Installation
+
+```shell
+pip install ryuuseigun
+```
+
+You will also need an ASGI server like [Uvicorn](https://uvicorn.dev/) or
+[Granian](https://github.com/emmett-framework/granian). These two servers have been tested with
+Ryūseigun, others have not.
+
+## Minimal Example
+
+```py
+from ryuuseigun import Ryuuseigun
+
+app = Ryuuseigun(__name__)
+```
+
+## Kitchen Sink Example
+
+```py
+from json import loads, dumps
+from ryuuseigun import Context, Response, Ryuuseigun
+
+app = Ryuuseigun(
+        __name__,
+        # Optional. If omitted, `ctx.url_for(..., full_url=True)` derives origin from request headers.
+        base_url='http://localhost:8000',
+        # A route ending with a slash is treated the same as a route without a slash
+        strict_slashes=False,
+        # Serve files from this path (e.g. public/favicon.ico -> website.com/favicon.ico)
+        public_dir='./public',
+        # Reject request bodies over this limit with HTTP 413 (set None to disable)
+        max_request_body_size=16 * 1024 * 1024,
+        # JSON parser/serializer hooks (swap with orjson.loads/orjson.dumps if desired)
+        loads=loads,
+        dumps=dumps,
+)
+
+# -------------- #
+# Error handlers #
+# -------------- #
+@app.error_handler(Exception)  # More specific exception classes will be prioritized
+async def handle_exceptions(ctx: Context, e: Exception) -> Response:
+    return Response(str(e), status=500)
+
+# ---------- #
+# Blueprints #
+# ---------- #
+from ryuuseigun import Blueprint
+
+api_bp = Blueprint('api', url_prefix='/api')
+
+@api_bp.get('/')
+async def api_index() -> str:
+    return 'API docs'
+
+@api_bp.error_handler(Exception)  # Blueprint-specific error handlers
+async def handle_api_errors(ctx: Context, e: Exception) -> dict:
+    return {
+        'success': True,
+        'message': str(e),
+    }
+
+users_bp = Blueprint('users', url_prefix='/users')
+
+@users_bp.get('/<username>')
+async def get_user(ctx: Context) -> str:
+    return ctx.request.route_params['username']
+
+api_bp.register_blueprint(users_bp)
+app.register_blueprint(api_bp)  # GET /api/users/caim -> 'caim'
+
+# ------------------------------------ #
+# Request globals & lifecycle handlers #
+# ------------------------------------ #
+from typing import cast
+
+@app.before_request
+async def before_all_requests(ctx: Context):
+    ctx.g['value'] = 123
+
+    @ctx.after_this_request  # Called after *this* request
+    async def after_all_requests(response: Response):
+        response.set_header('X-My-Value', str(ctx.g['value']))
+        return response
+
+    return None
+
+@app.route('/', methods=['GET'])
+async def index(ctx: Context) -> str:  # Route handlers can return `str`, `dict`, or `Response` (`Response.stream(...)` for streaming)
+    my_value = cast(int, ctx.g['value'])
+    return str(my_value)
+
+# -------------------- #
+# ASGI lifespan events #
+# -------------------- #
+@app.on_startup
+async def startup() -> None:
+    await connect_db()
+
+@app.on_shutdown
+async def shutdown() -> None:
+    await disconnect_db()
+
+# ---------------- #
+# Route parameters #
+# ---------------- #
+@app.post('/multiply/<int:num>/<int:factor>')  # HTTP method shortcuts for convenience
+async def index(ctx: Context) -> dict:
+    num = ctx.request.route_param('num', as_type=int)
+    factor = ctx.request.route_param('factor', as_type=int)
+    return {
+        'num': num,
+        'factor': factor,
+        'product': num * factor,
+    }
+
+# ------------------ #
+# Route converters   #
+# ------------------ #
+# Built-in converters: `int`, `float`, and `path`.
+# Route matching is specificity-aware: static segments and typed converters win over broader `path` captures.
+# Register custom route converters with parse/format behavior:
+app.register_converter(
+    'hex',
+    regex=r'[0-9a-fA-F]+',
+    parse=lambda raw: int(raw, 16),
+    format=lambda value: format(int(value), 'x'),
+)
+
+@app.get('/colors/<hex:color>')
+async def show_color(ctx: Context) -> dict:
+    color = ctx.request.route_param('color')  # int (parsed from hex)
+    return {'decimal': color}
+
+@app.get('/links/color')
+async def color_link(ctx: Context) -> dict:
+    # Uses converter `format`: -> /colors/ff
+    return {'url': ctx.url_for('show_color', color=255)}
+
+# Converters can also be scoped to blueprints:
+assets_bp = Blueprint('assets', url_prefix='/assets')
+assets_bp.register_converter(
+    'slugpath',
+    regex=r'.+',
+    parse=str,
+    format=str,
+    allows_slash=True,  # allow values like "images/icons/logo.svg"
+)
+
+@assets_bp.get('/<slugpath:key>')
+async def get_asset(ctx: Context) -> dict:
+    return {'key': ctx.request.route_param('key')}
+
+app.register_blueprint(assets_bp)
+
+# --------------------- #
+# Request body (async)  #
+# --------------------- #
+@app.post('/upload')
+async def upload(ctx: Context) -> dict:
+    total = 0
+    async for chunk in ctx.request.iter_body():
+        total += len(chunk)
+    return {'bytes': total}
+
+@app.post('/json')
+async def json_endpoint(ctx: Context) -> dict:
+    payload = await ctx.request.json_async()
+    return {'ok': True, 'payload': payload}
+
+# In ASGI request flow, body parsing is stream-first.
+# Use `await request.read()/json_async()/form_async()/payload_async()` for body access.
+
+# ------------------------------ #
+# Parsing/coercion customization #
+# ------------------------------ #
+# Register custom request payload parsers by content-type match:
+app.add_request_payload_parser(
+    'text/csv',
+    lambda request: [row.split(',') for row in request.body.decode('utf-8').splitlines() if row],
+    first=True,  # check before built-in parsers
+)
+
+# Register custom response coercers for arbitrary return types:
+class Box:
+    def __init__(self, value: str):
+        self.value = value
+
+app.add_response_coercer(
+    lambda result: Response(f'box:{result.value}', status=201) if isinstance(result, Box) else None,
+    first=True,
+)
+
+# ------------------------------ #
+# Conditional caching (optional) #
+# ------------------------------ #
+from datetime import datetime, timezone
+from ryuuseigun.utils import apply_conditional_response, make_etag
+
+@app.get('/assets/app.js')
+async def app_js(ctx: Context) -> Response:
+    body = b'console.log("hello")\n'
+    response = Response(
+        body=body,
+        headers={'content-type': 'application/javascript'},
+    )
+    return apply_conditional_response(
+        ctx,
+        response,
+        etag=make_etag(body),
+        last_modified=datetime(2026, 2, 20, tzinfo=timezone.utc),
+        cache_control='public, max-age=300',
+    )
+
+# If the client sends matching `If-None-Match` or `If-Modified-Since`,
+# `apply_conditional_response` returns HTTP 304 automatically.
+
+#----------#
+# Sessions #
+#----------#
+# Sessions default to an in-memory engine (per process, cookie-identified, not shared across workers).
+# You can tune it with `session_ttl`, `session_purge_interval`, and `session_max_entries`, or fully
+# replace storage by passing a custom `session_engine` object that implements: `load`, `create`,
+# `save`, and `destroy` as async methods.
+# Session access is async-first: use `await ctx.session_async()` when you need to create/load a
+# session.
+@app.get('/login')
+async def login(ctx: Context) -> str:
+    session = await ctx.session_async()
+    session['user_id'] = 123
+    return 'ok'
+
+@app.get('/me')
+async def me(ctx: Context) -> str:
+    session = await ctx.session_async()
+    user_id = session.get('user_id')
+    return str(user_id or 'anonymous')
+
+@app.get('/logout')
+async def logout(ctx: Context) -> str:
+    session = await ctx.session_async()
+    session.destroy()
+    return 'bye'
+
+```
+
+## Testing
+
+```shell
+pip install -e ".[test]"
+python -m pytest
+```