litestar-org / litestar-hello-world-stale

The minimum Litestar application

litestar-hello-world

Minimum Litestar Implementation.

$ poetry shell

$ poetry install

$ litestar run --reload

$ curl localhost:8000/ -w "\n"

To use for Litestar development

If you want to use this app to test a local version of Litestar, the litestar dependency in pyproject.toml to:

litestar = {path = "../litestar", develop = true}

This assumes that Litestar and this app exist in the same directory.

Run uvicorn with:

$ poetry run uvicorn main:app --reload --reload-dir "../litestar/litestar"

Code Quality

After cloning:

$ pre-commit install

Run on all files:

$ pre-commit run --all-files

Run a specific hook:

$ pre-commit run mypy --all-files

litestar-hello-world-stale's Issues

Docs: Errors in the readme?

Summary

Hey,

shouldn't you curl /sync or /async instead of / ? - otherwise you'll get a 404.

For the unicorn proccess, shouldn't the name be poetry run uvicorn app:app --reload

since there is no main?

ERROR: Error loading ASGI app. Could not import module "main".

Kind regards.

Docs: Fix readme typos

Summary

Readme has a couple typos. ltiestar-hello-world should be litestar-hello-world.

Maintenance: ci and dependabot