Metadata-Version: 2.4
Name: tasgi
Version: 0.1.0a1
Summary: Experimental thread-aware ASGI framework and runtime prototype.
Author: Vachagan
License: 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.
        
Keywords: asgi,asyncio,threads,http,websocket,openapi
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Framework :: AsyncIO
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Dynamic: license-file

# tasgi

`tasgi` means Thread ASGI. It is an experimental ASGI-compatible framework/runtime that keeps transport and protocol handling on the event loop while allowing handler execution on either the asyncio loop or a thread runtime.

Runtime design goal:

- the `tasgi` package itself depends only on the Python standard library
- external tools like `coverage`, `build`, and `twine` are used only for CI, testing, and packaging

## Status

`tasgi` is currently an alpha-stage project.

- public APIs are still settling
- auth APIs are still evolving
- router/module composition is still evolving
- native HTTP/2 support is still a prototype subset

Treat the current release line as experimental, not stable.

## Install

From source:

```bash
pip install -e .
```

`tasgi` does not require Poetry at runtime. The project is packaged from `pyproject.toml`
using the standard PEP 517 build flow, so CI and publishing use `pip`, `build`, and `twine`
directly instead of a Poetry-specific workflow.

After packaging to TestPyPI, the intended trial install flow is:

```bash
pip install --index-url https://test.pypi.org/simple/ tasgi
```

## Hello World

```python
from tasgi import TasgiApp, TextResponse

app = TasgiApp(docs=True, debug=True)

@app.route.get("/")
async def home(request):
    return TextResponse("hello from tasgi")
```

Run it:

```bash
tasgi
```

Or run the bundled demo app:

```bash
python3 examples/service_api/main.py
```

## Router Usage

`tasgi` now treats `app.route` as the main HTTP registration surface.

```python
from tasgi import JsonResponse, Router, TasgiApp

users = Router(tags=["users"])

@users.get("/users")
def list_users(request):
    return ["alice", "bob"]

app = TasgiApp()
app.include_router(users, prefix="/api")

@app.route.get("/status")
async def status(request):
    return JsonResponse({"ok": True})
```

## Core Model

`tasgi` is layered like this:

```text
socket/transport
  -> ASGI boundary
  -> tasgi runtime
  -> tasgi framework
  -> user handlers
```

Rules:

- network I/O stays on the event loop
- HTTP protocol handling stays on the event loop
- async handlers run on the asyncio loop
- sync handlers run in the tasgi thread runtime
- worker threads never write directly to sockets

## Dual Execution Model

App-level execution policy is explicit:

```python
from tasgi import ASYNC_EXECUTION, THREAD_EXECUTION, TasgiApp

app = TasgiApp(default_execution=THREAD_EXECUTION)

@app.route.get("/cpu")
def cpu(request):
    ...

@app.route.get("/status", execution=ASYNC_EXECUTION)
async def status(request):
    ...
```

## Request And Response Types

Main public HTTP types:

- `TasgiApp`
- `Router`
- `Request`
- `Response`
- `TextResponse`
- `JsonResponse`
- `StreamingResponse`

Handlers may return `Response` objects directly, or return typed values when a response model is declared.

## OpenAPI And Docs

Built-in docs can be enabled from app config:

```python
from dataclasses import dataclass
from tasgi import TasgiApp

@dataclass
class EchoIn:
    message: str

@dataclass
class EchoOut:
    echoed: str

app = TasgiApp(
    docs=True,
    title="tasgi demo",
    version="0.1.0a1",
)

@app.route.post("/echo", request_model=EchoIn, response_model=EchoOut)
def echo(request, body: EchoIn) -> EchoOut:
    return EchoOut(echoed=body.message)
```

Default docs endpoints:

- `/openapi.json`
- `/docs`

## Auth

`tasgi` includes an experimental pluggable auth layer.

Built-in starters:

- `BearerTokenBackend`
- `APIKeyBackend`
- `BasicAuthBackend`
- `RequireAuthenticated`
- `RequireScope`
- `RequireRole`

Example:

```python
from tasgi import BearerTokenBackend, Identity, RequireScope, TasgiApp

def validate_token(token: str):
    if token == "demo-token":
        return Identity(subject="alice", scopes=frozenset({"profile"}))
    if token == "admin-token":
        return Identity(subject="admin", scopes=frozenset({"admin"}))
    return None

app = TasgiApp(auth_backend=BearerTokenBackend(validate_token), docs=True)

@app.route.get("/public", auth=False)
async def public_route(request):
    return {"public": True}

@app.route.get("/me", auth=True)
async def me(request):
    return {"subject": request.identity.subject}

@app.route.get("/admin", auth=RequireScope("admin"))
async def admin(request):
    return {"subject": request.identity.subject}
```

Auth metadata is also reflected automatically in OpenAPI for built-in auth backends.

## Demo App

The bundled service example includes:

- HTTP routes
- router/module composition
- OpenAPI + Swagger UI
- auth examples
- streaming responses
- WebSocket echo
- thread-executed sync handlers

Run:

```bash
python3 examples/service_api/main.py
```

There is also a cleaner modular composition example:

```bash
python3 examples/modular_api/main.py
```

## Benchmarks

The benchmark suite exercises loopback TCP requests against a dedicated benchmark app.

Run:

```bash
python3 benchmarks/run_benchmarks.py
```

## CI And Publishing

GitHub Actions workflows are set up for both validation and releases:

- `CI` runs on every push and pull request
- the primary CI target is free-threaded CPython `3.14t`
- standard compatibility tests also run on Python 3.14, 3.13, 3.12, and 3.11
- coverage is reported in CI using `coverage run -m unittest discover -s tests`
- package builds are verified in CI with `python -m build` and `python -m twine check --strict dist/*`

Publishing is separated from CI:

- `Publish` runs only on version tags like `v0.1.0a1` or on published GitHub Releases
- release builds run on CPython `3.14t`
- PyPI upload is configured for Trusted Publishing via GitHub Actions
- before enabling real PyPI releases, do one TestPyPI dry run and confirm a clean install path

Local commands:

```bash
python3 -m unittest discover -s tests -v
python3 -m pip install coverage build twine
coverage run -m unittest discover -s tests
coverage report -m
python3 -m build
python3 -m twine check --strict dist/*
```

## Current Limits

- HTTP/2 support is prototype-grade, not production-complete
- auth API is still settling
- route registration APIs changed recently and may still evolve
- no middleware ecosystem yet
- no dependency injection container beyond explicit lightweight helpers
- no production-hardening claims

## License

`tasgi` is licensed under Apache-2.0. See `LICENSE` and `NOTICE`.

That keeps the project free to use, including in companies, while preserving
the attribution notices when the software is redistributed.

## Release Notes

This repository is currently prepared for an alpha-style release, not a stable release.

Before a public non-alpha release, the project still needs:

- final public API freeze
- repository/homepage URLs in package metadata
- a TestPyPI install-and-verify pass
