asfquart - a Quart framework for the ASF

PyPI PyPI - Python Versions Apache License

This is a Quart framework for ASF web applications.

On top of Quart, this package layers a lot of functionality, much of which is specific to the ASF and its infrastructure and preferred approaches for website application development.

asfquart adds the following items to basic quart:

simple construction of the APP
default config.yaml
watching the .py and config for changes, to cause a restart/reload
watch SIGINT to halt and SIGUSR2 to restart/reload
template watching and rendering for EZT templates
URL path routing for pages and API endpoints
Oauth with our ASF provider for authn
LDAP group testing for authz
long-running tasks and their lifecycle management

Current (known, public) users of asfquart:

Future users of asfquart:

Apache STeVe
Identity management (replaces the old id.a.o)
Gitbox UI
??

Primer

See the documentation page for more information.

import asfquart
from asfquart.auth import Requirements as R

def my_app():
    # Construct the quart service. By default, the oauth gateway is enabled at /oauth.
    app = asfquart.construct("my_app_service")

    @app.route("/")
    async def homepage():
        return "Hello!"

    @app.route("/secret")
    @asfquart.auth.require(R.committer)
    async def secret_page():
      return "Secret stuff!"
    
    asfquart.APP.run(port=8000)


if __name__ == "__main__":
    my_app()

Running unit tests for asfquart

To run manually, use the following commands from the root dir of this repo:

poetry run pytest