Metadata-Version: 1.1
Name: django-extra-fields
Version: 0.7
Summary: Additional fields for Django Rest Framework.
Home-page: UNKNOWN
Author: hipo
Author-email: pypi@hipolabs.com
License: License
Description: DRF-EXTRA-FIELDS
        ================
        
        Extra Fields for Django Rest Framework
        
        ![https://travis-ci.org/Hipo/drf-extra-fields.svg?branch=master](https://travis-ci.org/Hipo/drf-extra-fields.svg?branch=master)
        
        Usage
        ================
         
        install the package
         
        ```bash
        pip install django-extra-fields
        ```
        
        **Note:** 
        - Install version 0.1 for Django Rest Framework 2.*
        - Install version 0.3 or greater for Django Rest Framework 3.*
        
        
        Fields:
        ----------------
        
        
        ## Base64ImageField
        
        An image representation for Base64ImageField
        
        Intherited by `ImageField`
        
        
        **Signature:** `Base64ImageField()`
        
         - It takes a base64 image as a string.
         - a base64 image:  `data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7`
         - Base64ImageField accepts the entire string or just the part after base64, `R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7`
         - It takes the optional parameter represent_in_base64(False by default), if set to True it wil allow for base64-encoded downloads of an ImageField.
         
        
        **Example:**
         
        ```python
        # serializer
        
        from drf_extra_fields.fields import Base64ImageField
        
        class UploadedBase64ImageSerializer(serializers.Serializer):
            file = Base64ImageField(required=False)
            created = serializers.DateTimeField()
        
        # use the serializer
        file = 'R0lGODlhAQABAIAAAP///////yH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=='
        serializer = UploadedBase64ImageSerializer(data={'created': now, 'file': file})
        ```
            
            
        ## PointField
        
        Point field for GeoDjango
        
        
        **Signature:** `PointField()`
        
         - It takes a dictionary contains latitude and longitude keys like below
        
            {
             "latitude": 49.8782482189424,
             "longitude": 24.452545489
            }
            
        **Example:**
        
        ```python
        # serializer
        
        from drf_extra_fields.geo_fields import PointField
        
        class PointFieldSerializer(serializers.Serializer):
            point = PointField(required=False)
            created = serializers.DateTimeField()
        
        # use the serializer
        point = {
            "latitude": 49.8782482189424,
            "longitude": 24.452545489
            }
        serializer = PointFieldSerializer(data={'created': now, 'point': point})
        ```
        
        ## IntegerRangeField
        
        ```python
        from rest_framework import serializers
        from drf_extra_fields.fields import IntegerRangeField
        
        
        class RangeSerizalizer(serializers.Serializer):
            ranges = IntegerRangeField()
        
        
        serializer = RangeSerizalizer(data={'ranges': {'upper': 0, 'upper': 1}})
        
        ```
        
        ## FloatRangeField
        
        ```python
        from rest_framework import serializers
        from drf_extra_fields.fields import FloatRangeField
        
        
        class RangeSerizalizer(serializers.Serializer):
            ranges = FloatRangeField()
        
        
        serializer = IntegerRangeSerizalizer(data={'ranges': {'upper': 0., 'upper': 1.}})
        
        ```
        
        ## DateRangeField
        
        ```python
        import datetime
        
        from rest_framework import serializers
        from drf_extra_fields.fields import DateRangeField
        
        
        class RangeSerizalizer(serializers.Serializer):
            ranges = DateRangeField()
        
        
        serializer = RangeSerizalizer(data={'ranges': {'upper': datetime.date(2015, 1, 1), 'upper': datetime.date(2015, 2, 1)}})
        
        ```
        
        ## DateTimeRangeField
        
        ```python
        import datetime
        
        from rest_framework import serializers
        from drf_extra_fields.fields import DateTimeRangeField
        
        
        class RangeSerizalizer(serializers.Serializer):
            ranges = DateTimeRangeField()
        
        
        serializer = RangeSerizalizer(data={'ranges': {'upper': datetime.datetime(2015, 1, 1, 0), 'upper': datetime.datetime(2015, 2, 1, 0)}})
        
        ```
        
        CONTRIBUTION
        =================
        
        *TESTS*
        - Make sure that you add the test for contributed field to test/test_fields.py
        and run with command before sending a pull request:
        
        ```bash
        $ pip install tox  # if not already installed
        $ tox
        ```
        
        *README*
        - Make sure that you add the documentation for the field added to README.md
        
        
        LICENSE
        ====================
        
        Copyright DRF EXTRA FIELDS HIPO
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
            http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
