Python Rest Framework. Box utils for easy makes rest api on python
Project description
# [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...
```bash
pip install python-rest-framework
```
...or clone the project from github.
```bash
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
```python
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
```python
# 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
[![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...
```bash
pip install python-rest-framework
```
...or clone the project from github.
```bash
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
```python
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
```python
# 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for Python-Rest-Framework-0.1.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39d5959d6dcae1744144fdf8ae143aed2c80d8aec15f3e56847919775bd6daee |
|
MD5 | 2193a24f02c87dfcabd61f8333060cff |
|
BLAKE2b-256 | ab32d6b0b5f9de7fd13fee340b90eab38bda2c8b259966626ffdc74d5ba3483b |