Skip to main content

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

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

Python-Rest-Framework-0.1.7.tar.gz (32.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

Python_Rest_Framework-0.1.7-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file Python-Rest-Framework-0.1.7.tar.gz.

File metadata

  • Download URL: Python-Rest-Framework-0.1.7.tar.gz
  • Upload date:
  • Size: 32.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.4

File hashes

Hashes for Python-Rest-Framework-0.1.7.tar.gz
Algorithm Hash digest
SHA256 cc47da5f18df993e37e043dab6b520060f93b27e0558eca7ed5430ad856dd898
MD5 94a7daadf833aa0f2122e2cbfcd8ce22
BLAKE2b-256 e2dff09da4892b031bc7f6e6f60b206c0a26edd413cc920359840f2f55a3c994

See more details on using hashes here.

File details

Details for the file Python_Rest_Framework-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for Python_Rest_Framework-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 061ea7c2e1a865a45fc46de48cdb00d27ff0c5fed955487dae6208859ca089e7
MD5 50ebb57171071a245c02ccb473d0181b
BLAKE2b-256 61dd957cd01fdb138e5d65363f9d3aa6cd577eb996f1cdb048bb866f88c91f19

See more details on using hashes here.

Supported by

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