Classy Django REST Framework.

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

• Python 3.8+
• s3cmd (For deploy)

Building

On the project root, create a virtual envinroment using python -m venv env (it's important to use env as the name) and activate it.

pip install -r requirements.txt

fab build

The first build will take a while.

To run locally:

fab runserver

Deployment

create a .env file with the content:

AWS_BUCKET_NAME=''
AWS_ACCESS_KEY_ID=''
AWS_SECRET_ACCESS_KEY=''

Make sure you have built it as instructed above and deploy via

fab deploy

Tests

Install test dependencies: pip install -r requirements-test.txt

Run the tests with: fab test

Commercial Support

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]