https://github.com/nxexox/python-rest-framework
Python Rest Framework
https://github.com/nxexox/python-rest-framework
api frame framework python python3 rest rest-api web
Last synced: 5 months ago
JSON representation
Python Rest Framework
- Host: GitHub
- URL: https://github.com/nxexox/python-rest-framework
- Owner: nxexox
- License: apache-2.0
- Created: 2018-10-03T06:54:48.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-06-19T11:14:16.000Z (almost 6 years ago)
- Last Synced: 2024-10-18T23:18:22.723Z (over 1 year ago)
- Topics: api, frame, framework, python, python3, rest, rest-api, web
- Language: Python
- Homepage: https://nxexox.github.io/python-rest-framework/
- Size: 576 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [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
```
## Versions for Python Web Frameworks
```bash
pip install python-rest-framework[flask] # For Flask framework
pip install python-rest-framework[aiohttp] # For AioHttp framework
pip install python-rest-framework[sanic] # For Sanic framework
```
## 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/nxexox/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