"""icon" sizes="16x16" href="_static/icon/favicon-16x16.png" type="image/png"> """icon" sizes="32x32" href="_static/icon/favicon-32x32.png" type="image/png"> """icon" sizes="48x48" href="_static/icon/favicon-48x48.png" type="image/png"> """icon" sizes="192x192" href="_static/icon/favicon-192x192.png" type="image/png"> """icon" sizes="512x512" href="_static/icon/favicon-512x512.png" type="image/png"> """apple-touch-icon" sizes="180x180" href="_static/icon/apple-touch-icon-180x180.png" type="image/png"> """mask-icon" href="_static/icon/safari-pinned-tab.svg" type="image/svg+xml">"""search" title="Search" href="search.html">"""next" title="BSD-3-Clause License" href="license.html">"""prev" title="API" href="api.html"> """prefetch" href="_static/logo/logo-light.png" as="image"> """prefetch" href="_static/logo/logo-dark.png" as="image"> """stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" /> """stylesheet" type="text/css" href="_static/styles/furo.css?v=4db3a74f" /> """stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=99069b78" /> """stylesheet" type="text/css" href="_static/styles.css?v=6deb019a" /> """stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css" /> """stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/solid.min.css" /> """stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css" />
Skip to content
Flask-Session is switching serializer to msgspec in 1.0.0. Version 0.7.0 will migrate existing sessions upon read or write.
Back to top
View this page
Edit this page

# Contributing

## Getting started

### Using pip

Navigate to the project directory and run the following commands:

Create and activate a virtual environment

    $ python -m venv .venv
    $ source .venv/bin/activate

Install dependencies

    $ pip install -r requirements/dev.txt
    $ pip install -r requirements/docs.in

Install the package in editable mode

    $ pip install -e .

Lint the code

    $ ruff check --fix

Build updated documentation locally

    $ cd docs
    $ make html

or

    $ sphinx-build -b html docs docs/_build

Run the tests together or individually

    $ pytest tests
    $ pytest tests/test_basic.py

For easier startup and teardown of storage for testing you may use

    $ docker-compose up -d
    $ docker-compose down

### Using rye

    $ rye pin 3.11
    $ rye sync

    $ rye run python examples/hello.py

etc.

## Pull requests

Please check previous pull requests before submitting a new one.

Please ensure your pull requests are to the development branch.