Skip to main content

Adds Django Rest Framework inspired viewsets to Flask.

Project description

Flask-Viewsets

Flask-Viewsets is a Python package that provides a ViewSet class, inheriting from Flask's View, inspired by Django REST Framework's ViewSet. This package aims to streamline the development of RESTful APIs in Flask by offering a simple and flexible class-based view structure for mapping HTTP methods to defined actions on a per route basis.

Features

  • Provides an easy-to-use class-based view to manage HTTP methods.
  • Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, ...).
  • Extensible and customizable for various use cases.

Installation

You can install Flask-Viewsets using pip:

pip install Flask-Viewsets

Usage

To use the ViewSet class, import it in your Flask application, define a viewset class by inheriting ViewSet, and implement the desired HTTP methods. Here’s a simple example:

# views.py
from flask_viewsets import ViewSet

class ExampleViewSet(ViewSet):
    def hello(self):
        return "Hello, world!"

    def message(self, message: str):
        return message
# app.py
from flask import Flask

from . import views

app = Flask(__name__)
app.add_url_rule('/example', view_func=views.ExampleViewSet.as_view({
    "get": "hello"
}))
app.add_url_rule('/example/<string:message', view_func=views.ExampleViewSet.as_view({
    "get": "message"
}))

if __name__ == "__main__":
    app.run(debug=True)

Requirements

  • Python ^3.12
  • Flask ^3.0.3

Contributing

Contributions are welcome! Please feel free to submit a pull request, file an issue, or suggest improvements.

License

This project is licensed under the GNU Affero General Public License. See the LICENSE.md file for details.

Enjoy using Flask-Viewsets? Give it a star and help make Flask development easier!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask_viewsets-0.1.0.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

flask_viewsets-0.1.0-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file flask_viewsets-0.1.0.tar.gz.

File metadata

  • Download URL: flask_viewsets-0.1.0.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Linux/5.15.153.1-microsoft-standard-WSL2

File hashes

Hashes for flask_viewsets-0.1.0.tar.gz
Algorithm Hash digest
SHA256 980f11d1bd44a00a9e5d640dba0ccf7bc92e96746aaa8ec7bfe9feea30dea1b2
MD5 71ab7d97496d82115042721b07aeb260
BLAKE2b-256 ad502f86c70a192a0655039901155c2fbd5d4153069ccb5c3b64965d5d57f966

See more details on using hashes here.

File details

Details for the file flask_viewsets-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: flask_viewsets-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Linux/5.15.153.1-microsoft-standard-WSL2

File hashes

Hashes for flask_viewsets-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8a69eba94c4cdb9804a611d74d56a00c90cd0a1ac3c6013c945e0931b68c3404
MD5 7941b7718de3d8da78252c0bc838ff14
BLAKE2b-256 048991d4e48ae59cff27024322602e4e9101938bad25fe087cb8470842a4f3d5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page