flask-restalchemy 0.15.1

Flask extension to build REST APIs based on SQLAlchemy models

Flask-RESTAlchemy

A Flask extension to build REST APIs. It dismiss the need of building Schema classes, since usually all the information needed to serialize an SQLAlchemy instance is in the model itself.

By adding a model to the API, all its properties will be exposed:

class User(Base):

    __tablename__ = "User"

    id = Column(Integer, primary_key=True)
    firstname = Column(String)
    lastname = Column(String)
    email = Column(String)
    password = Column(String)


api = Api(flask_app)
api.add_model(User, "/user")

To change the way properties are serialized, declare only the one that needs a non-default behaviour:

from serialchemy import ModelSerializer, Field


class UserSerializer(ModelSerializer):

    password = Field(load_only=True)


api = Api(flask_app)
api.add_model(User, "/user", serializer_class=UserSerializer)

Development Setup

Requires uv.

uv python pin 3.10
uv sync --group dev
source .venv/bin/activate

If serialchemy is checked out as a sibling repository, install it as an editable dependency:

uv pip install -e ../serialchemy

Run the tests:

pytest src/flask_restalchemy/tests/

Release

A reminder for the maintainers on how to make a new release.

Note that the VERSION should folow the semantic versioning as X.Y.Z Ex.: v1.0.5

1. Create a release-VERSION branch from upstream/master.
2. Update CHANGELOG.rst.
3. Push a branch with the changes.
4. Once all builds pass, push a VERSION tag to upstream.
5. Merge the PR.