Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 2.36 KB

README.md

File metadata and controls

45 lines (26 loc) · 2.36 KB
Raw

Classy Django REST Framework.

Build Status Coverage Status

What is this?

Django REST framework is a powerful and flexible toolkit that makes it easy to build Web APIs. It provides class based generic API views and serializers. We've taken all the attributes and methods that every view/serializer defines or inherits, and flattened all that information onto one comprehensive page per class. This project is heavily based on Classy Class-Based Views and was developed by Vinta Software Studio.

Dependencies

  • Classy Django REST Framework is ready for development with Dev Container. After downloading the code you just need to use "Reopen in Container" option and after building run pip install -r requirements-test.txt just once.

Building

fab build

The first build will take a while.

Run locally:

fab runserver

Deployment

Tests

fab test

Adding a new version

  1. Add the version to rest_framework_ccbv.config.py::REST_FRAMEWORK_VERSIONS
  2. In build.ini:
    • Add the version to envlist
    • Add the deps to the version, use the latest supported django version (check deps314)
    • Add the index generation (check testenv:drf314)
    • Add the doc generation (check testenv:drfbuild314)
  3. Update requirements-test.txt to use the latest supported DRF version and its latest supported Django version

Commercial Support

alt text

This project is maintained by Vinta Software and is used in products of Vinta's clients. We are always looking for exciting work, so if you need any commercial support, feel free to get in touch: [email protected]