Skip to main content

restframework-definable-serializer

Project description

[![CircleCI](https://circleci.com/gh/salexkidd/restframework-definable-serializer/tree/master.svg?style=svg)](https://circleci.com/gh/salexkidd/restframework-definable-serializer/tree/master) ![RTD](https://media.readthedocs.org/static/projects/badges/passing.svg)

# restframework-definable-serializer

restframework-definable-serializer is definable serializer by JSON or YAML format.


# Feature
- It can define restframework serializer by JSON or YAML
- It can write and modify serializer by django admin pages.


# Dependencies
- python 3
- django >= 1.11
- djangorestframework>=3.7.0
- django-codemirror2>=0.2
- django-jsonfield>=1.0.1
- django-yamlfield>=1.0.3
- PyYAML>=3.12
- ruamel.yaml>=0.13.5
- simplejson>=3.11.1
- six>=1.11.0


# Quick start

1. Install restframework-definable-serializer

```
pip install restframework-definable-serializer
```

2. Add "definable_serializer" and "codemirror2" to your INSTALLED_APPS setting like this:

```
INSTALLED_APPS = [
...
'definable_serializer',
'codemirror2',
]
```

# Documentation

For extensive Japanese documentation see the docs read it on [Readthedocs](http://restframework-definable-serializer.readthedocs.io/ja/latest/)

## Translation

[Transifex(https://www.transifex.com/restframework-definable-serializer/restframework-definable-serializer-documentation/dashboard/)](https://www.transifex.com/restframework-definable-serializer/restframework-definable-serializer-documentation/dashboard/) is used to manage translations.

Feel free to improve translations.

Currently supported languages are:
- Japanese

You can request to add your own language directly on Transifex.


# Sample code
You can try restframework-definable-serializer.
See [example_project](https://github.com/salexkidd/restframework-definable-serializer-example)


Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

restframework_definable_serializer-0.1.16-py2.py3-none-any.whl (16.1 kB view hashes)

Uploaded Python 2 Python 3

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