3
0
Fork 0

feat: add support for running via uvicorn; wutta webapp command

This commit is contained in:
Lance Edgar 2024-12-18 11:28:08 -06:00
parent 3fabc0a141
commit b6d5ffa8ce
13 changed files with 408 additions and 28 deletions

View file

@ -0,0 +1,6 @@
``wuttaweb.cli``
================
.. automodule:: wuttaweb.cli
:members:

View file

@ -0,0 +1,6 @@
``wuttaweb.cli.webapp``
=======================
.. automodule:: wuttaweb.cli.webapp
:members:

View file

@ -21,6 +21,7 @@ extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
'sphinx.ext.todo',
'sphinxcontrib.programoutput',
]
templates_path = ['_templates']

View file

@ -19,6 +19,7 @@ the narrative docs are pretty scant. That will eventually change.
:caption: Documentation:
glossary
narr/cli/index
narr/templates/index
.. toctree::
@ -28,6 +29,8 @@ the narrative docs are pretty scant. That will eventually change.
api/wuttaweb
api/wuttaweb.app
api/wuttaweb.auth
api/wuttaweb.cli
api/wuttaweb.cli.webapp
api/wuttaweb.conf
api/wuttaweb.db
api/wuttaweb.db.continuum

28
docs/narr/cli/builtin.rst Normal file
View file

@ -0,0 +1,28 @@
===================
Built-in Commands
===================
Below are the :term:`subcommands <subcommand>` which come with
WuttaWeb.
.. _wutta-webapp:
``wutta webapp``
----------------
Run the web app, according to config file(s).
This command is a convenience only; under the hood it can run `uvicorn
<https://www.uvicorn.org/#uvicornrun>`_ but by default will run
whatever :ref:`pserve <pyramid:pserve_script>` is setup to do (which
usually is `waitress
<https://docs.pylonsproject.org/projects/waitress/en/latest/index.html>`_).
Ultimately it's all up to config, so run different web apps with
different config files.
Defined in: :mod:`wuttaweb.cli.webapp`
.. program-output:: wutta webapp --help

14
docs/narr/cli/index.rst Normal file
View file

@ -0,0 +1,14 @@
==============
Command Line
==============
There isn't much to the command line for WuttaWeb, but here it is.
For more general info about CLI see
:doc:`wuttjamaican:narr/cli/index`.
.. toctree::
:maxdepth: 2
builtin