flask-restalchemy

KO | EN

gitlite — search

#hacktoberfest #typescript #llm #golang #deep-learning #docker #java #windows #cli #awesome-list #vue #security #ios #mcp

flask-restalchemy

(★ 35)

Flask extension to build REST APIs based on SQLAlchemy models

flask-restalchemy Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Flask-RESTAlchemy #

[![build](https://github.com/ESSS/serialchemy/workflows/build/badge.svg)](https://github.com/ESSS/serialchemy/actions)
[![codecov](https://codecov.io/gh/ESSS/flask-restalchemy/branch/master/graph/badge.svg)](https://codecov.io/gh/ESSS/flask-restalchemy)
[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![black](https://img.shields.io/readthedocs/flask-restalchemy.svg)](https://flask-restalchemy.readthedocs.io/en/latest)

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:

```python
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:

```python
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](https://docs.astral.sh/uv/).

```bash
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:

```bash
uv pip install -e ../serialchemy
```

Run the tests:

```bash
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.

[Changelog]: https://regro.github.io/rever-docs/devguide.html#changelog

flask-restalchemy

flask-restalchemy Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

flask-restalchemy

flask-restalchemy Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README