Metadata-Version: 2.1
Name: djangojsendresponses
Version: 0.1.1
Summary: Ready Jsend specified response classes.
Home-page: https://github.com/Ibrohimbek/django-jsend-responses
Author: Ibrohim Ermatov
Author-email: ibrohimbek@gmail.com
License: UNKNOWN
Description: # Django Jsend Responses
        
        
        **Jsend specified Responses for APIs.**
        
        ---
        
        # Overview
        
        Django Jsend Responses supply response classes to use in projects created with Django.
        See http://labs.omniti.com/labs/jsend for jsend spec.
        
        ----
        
        # Requirements
        
        * Django (1.11, 2.0, 2.1)
        
        # Installation
        
        Install using `pip`...
        
            pip install djangojsendresponses
        
        
        # Using in a code
        
        ```python
        from jsend_responses import SuccessResponse
        from rest_framework.views import APIView
        
        
        class DriverAPIView(APIView):
            def get(self):
                driver = get_random_driver()
                return SuccessResponse(object=driver)
        
        ```
        
        # Response examples
        
        
        Success response:
        
            {
                "status": "success",
                "data": {
                    "object": { 
                        "id": 1, 
                        "name": "Fist object"
                    }
                }
            }
            
        
        Fail response:
        
            {
                "status" : "fail",
                "data" : {
                    "name" : "A name is required" 
                }
            }
        
        
        Error response:
        
            {
                "status" : "error",
                "message" : "A service is unavailable to connect"
            }
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
