This package is maintained with git-buildpackage(1). It follows DEP-14 for
branch naming (e.g. using debian/main for the current version in Debian
unstable due Debian Python team policy).

It uses pristine-tar(1) to store enough information in git to generate bit
identical tarballs when building the package without having downloaded an
upstream tarball first.

When working with patches it is recommended to use "gbp pq import" to import
the patches, modify the source and then use "gbp pq export --commit" to commit
the modifications.

The changelog is generated using "gbp dch" so if you submit any changes don't
bother to add changelog entries but rather provide a nice git commit message
that can then end up in the changelog.

It is recommended to build the package with pbuilder using:

    gbp buildpackage --git-pbuilder

For information on how to set up a pbuilder environment see the git-pbuilder(1)
manpage. In short:

    DIST=sid git-pbuilder create
    gbp clone https://salsa.debian.org/python-team/packages/litestar.git
    cd litestar
    gbp buildpackage --git-pbuilder


Disabled tests in debian/rules
------------------------------

Some tests from the test suite are disabled, e.g. because they use docker or
the needed dependencies are not available yet in Debian. Note the bin packages
python3-* in the following list are assumed as only python-polyfactory has an
ITP bug.

 --ignore=tests/examples/test_contrib/test_sqlalchemy/plugins/test_example_apps.py \   #
 --ignore=tests/examples/test_pagination/test_using_classic_pagination.py \            # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/examples/test_pagination/test_using_cursor_pagination.py \             # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/examples/test_pagination/test_using_offset_pagination.py \             # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/examples/test_security/test_jwt/test_using_jwt_auth.py \               # python3-jose
 --ignore=tests/examples/test_security/test_jwt/test_using_jwt_cookie_auth.py \        # python3-jose
 --ignore=tests/examples/test_security/test_jwt/test_using_oauth2_password_bearer.py \ # python3-jose
 --ignore=tests/unit/test_channels/test_backends.py \                                  # other, needs docker
 --ignore=tests/unit/test_channels/test_plugin.py \                                    # other, TypeError: _FlakyPlugin._make_test_flaky() got an unexpected keyword argument 'reruns'
 --ignore=tests/unit/test_cli/test_schema_commands.py \                                # other, KeyError: 'test_fn', No module named 'test_apps', python3-polyfactory
 --ignore=tests/unit/test_contrib/test_attrs/test_schema_spec_generation.py \          # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_contrib/test_opentelemetry.py \                              # python3-opentelemetry-{api,sdk}
 --ignore=tests/unit/test_contrib/test_piccolo_orm/test_piccolo_orm_dto.py \           # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_contrib/test_pydantic/test_integration.py \                  # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_contrib/test_pydantic/test_openapi.py \                      # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_controller.py \                                              # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_dto/test_factory/test_utils.py \                             # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_file_system.py \                                             # other, DID NOT RAISE <class 'litestar.exceptions.http_exceptions.NotAuthorizedException'>
 --ignore=tests/unit/test_handlers/test_http_handlers/test_media_type.py \             # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_handlers/test_http_handlers/test_validations.py \            # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_kwargs/test_reserved_kwargs_injection.py \                   # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_kwargs/test_validations.py \                                 # other, KeyError: 'test_fn'
 --ignore=tests/unit/test_openapi \                                                    # python3-opentelemetry-{api,sdk}
 --ignore=tests/unit/test_pagination.py \                                              # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_response/test_response_to_asgi_response.py \                 # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_response/test_serialization.py \                             # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_security/test_jwt/test_auth.py \                             # python3-jose
 --ignore=tests/unit/test_security/test_jwt/test_integration.py \                      # python3-jose
 --ignore=tests/unit/test_security/test_jwt/test_token.py \                            # python3-jose
 --ignore=tests/unit/test_security/test_session_auth.py \                              # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_stores.py \                                                  # other, needs docker
 --ignore=tests/unit/test_testing/test_request_factory.py \                            # python3-polyfactory ITP https://bugs.debian.org/1092011
 --ignore=tests/unit/test_testing/test_test_client.py \                                # other, needs docker
 --ignore=tests/unit/test_utils/test_typing.py \                                       # python3-polyfactory ITP https://bugs.debian.org/1092011


Dependencies for litestar-doc
-----------------------------

 sphinx>=7.1.2                 python3-sphinx
 sphinx-autobuild>=2021.3.14   python3-sphinx-autobuild
 sphinx-copybutton>=0.5.2      python3-sphinx-copybutton
 sphinx-toolbox>=3.5.0         NEW (python3-sphinx-toolbox https://bugs.debian.org/1081111)
 sphinx-design>=0.5.0          python3-sphinx-design
 sphinx-click>=4.4.0           python3-sphinx-click
 sphinxcontrib-mermaid>=0.9.2  python3-sphinxcontrib-mermaid
 auto-pytabs[sphinx]>=0.4.0    python3-auto-pytabs
 litestar-sphinx-theme @ git+https://github.com/litestar-org/litestar-sphinx-theme.git not really needed
 sphinx-paramlinks>=0.6.0      python3-sphinx-paramlinks


 -- Carsten Schoenert <c.schoenert@t-online.de>  Mon, 03 Feb 2025 19:29:00 +0200
