Skip to main content

Additional fields for Django Rest Framework 3.

Project description

DRF-EXTRA-FIELDS
================

Extra Fields for Django Rest Framework

Usage
================

install the package

`pip install django-extra-fields`



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 only the part after base64, `R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7`


**Example:**

#serializer
from drf_extra_fields.fields import Base64ImageField

class UploadedBase64ImageSerializer(serializers.Serializer):
file = serializers.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:**

#serializer
from drf_extra_fields.geo_fields import PointField

class PointFieldSerializer(serializers.Serializer):
file = PointField(required=False)
created = serializers.DateTimeField()

#use the serializer
point = {
"latitude": 49.8782482189424,
"longitude": 24.452545489
}
serializer = PointFieldSerializer(data={'created': now, 'point': point})


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:
`python drf_extra_fields/runtests/runtests.py`

*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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-extra-fields-0.3.tar.gz (3.9 kB view details)

Uploaded Source

File details

Details for the file django-extra-fields-0.3.tar.gz.

File metadata

File hashes

Hashes for django-extra-fields-0.3.tar.gz
Algorithm Hash digest
SHA256 9126776ca7d7b29156ee85b6a60433dff0b076d82ddc808179d54334d6f1c969
MD5 7d6a565509b0e0682be3a34a9559551a
BLAKE2b-256 9822cf80acd5d10fa2da372857e539476d28eff7c813d914e161a51fe746171a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page