Metadata-Version: 2.1
Name: rest_meets_djongo
Version: 0.0.4
Summary: Allows for automatic serialization of Djongo fields w/ Django REST
Home-page: https://gitlab.com/SomeoneInParticular/rest_meets_djongo
Author: Kalum J. Ost
Author-email: kalumost@gmail.com
License: MIT
Description: rest-meets-djongo
        ===
        A package which enables serialization of Djongo fields with django-rest-framework's (DRF) serializers and viewsets
        
        ## Features
        **NOTE: This repo is currently under development, and most (if not all) of its features are likely to throw errors or 
        behave in unexpected ways; use at your own risk**
        
        Similiar to DRF ModelSerializers, creating serializers using DjongoModelSerializer allows for the following fields to be 
        detected and managed through DRF's serializer setup. These fields include Djongo's:
        * ObjectIDField
        * EmbeddedModelField (both as a standalone field and as a custom built serializer)
        * ArrayModelField
        * ArrayReferenceField
        
        ## Usage
        <ol><li>
        Install rest-meets-djongo:
        
        ```
        pip install rest_meets_djongo
        ```
        
        </li><li>
        Into settings.py file of your project, add:
        
        ```python
        INSTALLED_APPS = [
            ...
            'rest_meets_djongo',
        ]
        ```
        
        </li><li>
        Replace REST's 'ModelSerializer' with 'DjongoModelSerializer' and enjoy the automation of EmbeddedModels and ObjectID 
        fields!
        
        </li></ol>
        
        ## Requirements:
        (Earlier version testing is currently being testing; 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.2 or higher
        
        
        
Keywords: mongodb djongo rest_framework rest apis fields
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
