rest-meets-djongo

This package enables default model serializers for models with Djongo fields to be generated, for use in Django-Rest-Framework apps

THIS REPOSITORY IS NOW DEFUNCT. YOU ARE FREE TO USE THE CODE HEREIN FOR YOUR PURPOUSES, BUT IT WILL NO LONGER BE UPDATED. YOU ARE ALSO WELCOME TO FORK THE CODE FOR YOUR OWN PURPOSES.

Features

NOTE: This repo is currently under active development, and many of the features of the package may act in strange ways. Please report any issues to GitLab or GitHub as you find them

Similar to DRF ModelSerializers, creating serializers using DjongoModelSerializer allows for the following fields to be detected and automatically managed through DRF's serializer setup. These fields include:

• ObjectIDField
• EmbeddedField
• ArrayField

The following are currently not fully functional, and as a result are not explicitly supported (yet):

• ArrayReferenceField (WIP)

Some fields are not currently supported fully within Djongo, and as such are not supported by this package either (though they will work to an extent nonetheless):

• ForeignKeyField (Reverse relations are not generated, even if specified, by Djongo)
• ManyToManyField (Reverse relations are not generated, even if specified, by Djongo)

Installation

1. Install rest-meets-djongo:

   pip install rest-meets-djongo
   

2. Replace REST's 'ModelSerializer' with 'DjongoModelSerializer' and enjoy!

Requirements

(Alternate version testing is currently underway; these are just the confirmed functional versions)

1. Python 3.6 or higher
2. MongoDB 4.0 or higher
3. djangorestframework 3.9 or higher
4. djongo 1.3 or higher (use version 0.11 for djongo 1.2 versions)