tatami.convention module

tatami.convention.build_app_from_dir(path, mode=None, **kwargs)[source]

Backward compatibility function that returns only the app. For new code, prefer using build_from_dir which returns both app and introspection.

Parameters:

  • path (str)

  • mode (str | None)

Return type:

BaseRouter

tatami.convention.build_from_dir(path, mode=None, routers_dir='routers', services_dir='services', middleware_dir='middleware', models_dir='models', mounts_dir='mounts', static_dir='static', templates_dir='templates', favicon_file='favicon.ico', readme_file='README.md')[source]
Parameters:

  • path (str)

  • mode (str | None)

  • routers_dir (str)

  • services_dir (str)

  • middleware_dir (str)

  • models_dir (str)

  • mounts_dir (str)

  • static_dir (str)

  • templates_dir (str)

  • favicon_file (str)

  • readme_file (str)

Return type:

tuple[BaseRouter, ProjectIntrospection]

tatami.convention.create_project(path, routers_dir='routers', services_dir='services', middleware_dir='middleware', models_dir='models', mounts_dir='mounts', static_dir='static', templates_dir='templates', favicon_file='favicon.ico', readme_file='README.md')[source]
Parameters:

  • path (str)

  • routers_dir (str)

  • services_dir (str)

  • middleware_dir (str)

  • models_dir (str)

  • mounts_dir (str)

  • static_dir (str)

  • templates_dir (str)

  • favicon_file (str)

  • readme_file (str)

Return type:

None

tatami.convention.get_favicon_router(favicon_path)[source]
Parameters:

favicon_path (str)

Return type:

Callable[[Request], FileResponse]