Metadata-Version: 2.1
Name: Python-Rest-Framework
Version: 0.1.4
Summary: Python Rest Framework. Box utils for easy makes rest api on python
Home-page: https://github.com/nxexox/python-rest-framework
Author: Deys Timofey
Author-email: nxexox@gmail.com
Maintainer: Deys Timofey
Maintainer-email: nxexox@gmail.com
License: Apache 2.0
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Dist: six (>=1)

# [Python Rest Framework][docs]

[![pypi-version]][pypi]
[![build-status-image]][travis]
[![coverage-status-image]][codecov]

Python Rest Framework is a full-fledged rest api engine.
You can concentrate all your strength on business logic, take care of the rest of the Python Rest Framework.

Full documentation for the project is available at [https://nxexox.github.io/python-rest-framework/][docs].

## Requirements

* Python (3.4, 3.5, 3.6, 3.7)
* six

## Installation

Install using `pip`, including any optional packages you want...

    pip install python-rest-framework

...or clone the project from github.

    git clone git@github.com:nxexox/python-rest-framework.git


## Example

For example, we will serialize the data from the request object.

First we write the serializer

    from rest_framework.serializers import (
        Serializer, CharField, IntegerField, ListField, FloatField
    )

    # Example serializer for parsing body data from web request.
    class ExampleSerializer(Serializer):
        char_field = CharField(label='This char field', required=True)
        int_field = IntegerField(label='This int field', required=True)
        list_float_field = ListField(child=FloatField(), required=True, min_length=2)

---

Now we process the request body with a serializer

    # web request data
    data = {
        'char_field': 'example', 'int_field': 1,
        'list_float_field': [1.0, 1.1, 1.2]
    }

    ser = ExampleSerializer(data=data)
    if ser.is_valid():
        print(ser.validated_data)
    else:
        print(ser.errors)

[docs]: https://nxexox.github.io/python-rest-framework/
[pypi-version]: https://img.shields.io/pypi/v/python-rest-framework.svg
[pypi]: https://pypi.org/project/Python-Rest-Framework/
[build-status-image]: https://travis-ci.org/nxexox/python-rest-framework.svg?branch=master
[travis]: https://travis-ci.org/encode/python-rest-framework?branch=master
[coverage-status-image]: https://codecov.io/gh/nxexox/python-rest-framework/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/nxexox/python-rest-framework


