Allows for automatic serialization of Djongo fields w/ Django REST
Project description
rest-meets-djongo
This package enables default model serializers for models with Djongo fields to be generated, for use in Django-Rest-Framework apps
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 'https://gitlab.com/SomeoneInParticular/rest_meets_djongo/issues' 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
- EmbeddedModelField
- ArrayModelField
The following are currently not fully functional, and as a result are not explicitly supported (yet):
- ForeignKeyField (Reverse relations are not generated, even if specified, by Djongo)
- ManyToManyField (Reverse relations are not generated, even if specified, by Djongo)
- ArrayReferenceField (WIP)
Installation
-
Install rest-meets-djongo:
pip install rest-meets-djongo
- Replace REST's 'ModelSerializer' with 'DjongoModelSerializer' and enjoy!
Requirements
(Alternate version testing is currently underway; these are just the confirmed functional versions)
- Python 3.6 or higher
- MongoDB 4.0 or higher
- djangorestframework 3.9 or higher
- djongo 1.2 or higher
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.