restframework-definable-serializer


Namerestframework-definable-serializer JSON
Version 0.2.2 PyPI version JSON
download
home_pagehttps://github.com/salexkidd/restframework-definable-serializer
Summaryrestframework-definable-serializer
upload_time2025-01-13 14:57:16
maintainerNone
docs_urlNone
authorsalexkidd
requires_pythonNone
licenseMIT
keywords django restframework serializer
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            [![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.12
- django>=4
- djangorestframework>=3.15.0
- django-codemirror2>=0.2
- django-jsonfield>=1.0.1
- django-yamlfield>=1.0.3
- PyYAML>=5.2
- ruamel.yaml>=0.13.5
- simplejson>=3.11.1
- six>=1.13.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)

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/salexkidd/restframework-definable-serializer",
    "name": "restframework-definable-serializer",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "django, restframework, serializer",
    "author": "salexkidd",
    "author_email": "salexkidd@gmail.com",
    "download_url": null,
    "platform": null,
    "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)\n\n# restframework-definable-serializer\n\nrestframework-definable-serializer is definable serializer by JSON or YAML format.\n\n\n# Feature\n- It can define restframework serializer by JSON or YAML\n- It can write and modify serializer by django admin pages.\n\n\n# Dependencies\n- python>=3.12\n- django>=4\n- djangorestframework>=3.15.0\n- django-codemirror2>=0.2\n- django-jsonfield>=1.0.1\n- django-yamlfield>=1.0.3\n- PyYAML>=5.2\n- ruamel.yaml>=0.13.5\n- simplejson>=3.11.1\n- six>=1.13.0\n\n\n# Quick start\n\n1. Install restframework-definable-serializer\n\n```\npip install restframework-definable-serializer\n```\n\n2. Add \"definable_serializer\" and \"codemirror2\" to your INSTALLED_APPS setting like this:\n\n```\nINSTALLED_APPS = [\n    ...\n    'definable_serializer',\n    'codemirror2',\n]\n```\n\n# Documentation\n\nFor extensive Japanese documentation see the docs read it on [Readthedocs](http://restframework-definable-serializer.readthedocs.io/ja/latest/)\n\n## Translation\n\n[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.\n\nFeel free to improve translations.\n\nCurrently supported languages are:\n   - Japanese\n\nYou can request to add your own language directly on Transifex.\n\n\n# Sample code\nYou can try restframework-definable-serializer.\nSee [example_project](https://github.com/salexkidd/restframework-definable-serializer-example)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "restframework-definable-serializer",
    "version": "0.2.2",
    "project_urls": {
        "Homepage": "https://github.com/salexkidd/restframework-definable-serializer"
    },
    "split_keywords": [
        "django",
        " restframework",
        " serializer"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "429eccdf40d590a0abc470e3e77fd931690aa42ca8c11fd621d0cd74c045da7d",
                "md5": "a0bade909f060da6935371af9bd857e3",
                "sha256": "5928705da6340cb1f4d6258b65c2b3c9b2a847db2183e87351edd6d367f59991"
            },
            "downloads": -1,
            "filename": "restframework_definable_serializer-0.2.2-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a0bade909f060da6935371af9bd857e3",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 15439,
            "upload_time": "2025-01-13T14:57:16",
            "upload_time_iso_8601": "2025-01-13T14:57:16.874954Z",
            "url": "https://files.pythonhosted.org/packages/42/9e/ccdf40d590a0abc470e3e77fd931690aa42ca8c11fd621d0cd74c045da7d/restframework_definable_serializer-0.2.2-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-13 14:57:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "salexkidd",
    "github_project": "restframework-definable-serializer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "circle": true,
    "tox": true,
    "lcname": "restframework-definable-serializer"
}
salexkidd
Elapsed time: 0.43962s