{ "info": { "author": "Vyacheslav V.V.", "author_email": "vvvyacheslav23@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.10", "Framework :: Django :: 1.11", "Framework :: Django :: 1.9", "Framework :: Django :: 2.0", "Framework :: Django :: 2.1", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Internet :: WWW/HTTP" ], "description": "django-rest-framework-datatables-editor\n=======================================\n\n|build-status-image| |codecov-image| |documentation-status-image| |pypi-version| |py-versions|\n\nOverview\n--------\n\nThis package provides seamless integration between `Django REST framework `_ and `Datatables `_ with supporting `Datatables editor `_.\n\n- It handles searching, filtering, ordering and most usecases you can imagine with Datatables.\n\n- You don't have to create a different API, your API still work exactly the same .\n\nHow to use\n----------\n\nInstall\n~~~~~~~\n\n.. code:: bash\n\n $ pip install djangorestframework-datatables-editor\n\nIf you need the functionality of the editor, you also need to download the data editor from `here `_, the JS+CSS version, and put the downloaded files in ``static`` folder.\n\nConfiguration\n~~~~~~~~~~~~~\n\nTo enable Datatables support in your project, add ``'rest_framework_datatables_editor'`` to your ``INSTALLED_APPS``, and modify your ``REST_FRAMEWORK`` settings like this:\n\n.. code:: python\n\n REST_FRAMEWORK = {\n 'DEFAULT_RENDERER_CLASSES': (\n 'rest_framework.renderers.JSONRenderer',\n 'rest_framework.renderers.BrowsableAPIRenderer',\n 'rest_framework_datatables_editor.renderers.DatatablesRenderer',\n ),\n 'DEFAULT_FILTER_BACKENDS': (\n 'rest_framework_datatables_editor.filters.DatatablesFilterBackend',\n ),\n 'DEFAULT_PAGINATION_CLASS': 'rest_framework_datatables_editor.pagination.DatatablesPageNumberPagination',\n 'PAGE_SIZE': 50,\n }\n\nFor using Datatables editor you should use DatatablesEditorModelViewSet instead ModelViewSet or add EditorModelMixin to your views.\n\nAnd that's it !\n~~~~~~~~~~~~~~~\n\nYour API is now fully compatible with Datatables and will provide searching, filtering, ordering and pagination without any modification of your API code ! For using Datatables editor you should use DatatablesEditorModelViewSet instead ModelViewSet or add EditorModelMixin to your views.\n\nConfiguring Datatables and Datatables editor\n--------------------------------------------\n\n- The URL for connecting datatables is the URL of your view with ``?format=datatables``\n- The URL connecting datatables editor is the URL of your view with ``editor/``\n- Full documentation is available on `Read the Docs `_ !\n- Also you'll need download `Datatables editor `_.\n\nExample of HTML code:\n\n.. code:: html\n\n\n\n \n \n \n \n Rolling Stone Top 500 albums of all time\n \n \n \n \n \n \n \n
\n
\n
\n \n \n \n \n \n \n \n \n \n \n
RankArtistAlbum nameYearGenres
\n
\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n\nThanks\n------------\n\nThe project is based on the project `django-rest-framework-datatables `_ by `David Jean Louis `_\n\n\nRequirements\n------------\n\n- Python (2.7, 3.4, 3.5, 3.6)\n- Django (1.11, 2.0, 2.1)\n- Django REST Framework (3.9)\n\nExample project\n---------------\n\nTo play with the example project, just clone the repository and run the dev server.\n\n.. code:: bash\n\n $ git clone https://github.com/VVyacheslav/DRF-datatables-editor.git\n $ cd DRF-datatables-editor\n Activate virtualenv.\n $ pip install -r requirements-dev.txt\n $ python example/manage.py runserver\n $ firefox http://127.0.0.1:8000\n\nTesting\n-------\n\nInstall development requirements.\n\n.. code:: bash\n\n $ pip install -r requirements-dev.txt\n\nRun the tests.\n\n.. code:: bash\n\n $ python example/manage.py test\n\nYou can also use the excellent `tox`_ testing tool to run the tests\nagainst all supported versions of Python and Django. Install tox\nglobally, and then simply run:\n\n.. code:: bash\n\n $ tox\n\nIf you want to check the coverage, use:\n\n.. code:: bash\n\n $ coverage run ./example/manage.py test\n $ coverage report -m\n\n\n.. _tox: http://tox.readthedocs.org/en/latest/\n\n.. |build-status-image| image:: https://travis-ci.com/VVyacheslav/django-rest-framework-datatables-editor.svg?branch=master\n :target: https://travis-ci.com/VVyacheslav/django-rest-framework-datatables-editor\n :alt: Travis build\n\n.. |codecov-image| image:: https://codecov.io/gh/VVyacheslav/django-rest-framework-datatables-editor/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/VVyacheslav/django-rest-framework-datatables-editor\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/djangorestframework-datatables-editor.svg\n :target: https://pypi.python.org/pypi/djangorestframework-datatables-editor\n :alt: Pypi version\n\n.. |documentation-status-image| image:: https://readthedocs.org/projects/drf-datatables-editor/badge/?version=latest\n :target: https://drf-datatables-editor.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |py-versions| image:: https://img.shields.io/pypi/pyversions/djangorestframework-datatables-editor.svg\n :target: https://img.shields.io/pypi/pyversions/djangorestframework-datatables.svg\n :alt: Python versions\n\n.. |dj-versions| image:: https://img.shields.io/pypi/djversions/djangorestframework-datatables.svg\n :target: https://img.shields.io/pypi/djversions/djangorestframework-datatables.svg\n :alt: Django versions\n\n\nChangelog\n=========\n\nVersion 0.3.2 (2019-05-23):\n---------------------------\n\n- Fixed checking fields when deleting\n\n\nVersion 0.3.1 (2019-05-22):\n---------------------------\n\n- Fixed requirements\n\nVersion 0.3.0 (2019-05-06):\n---------------------------\n\n- Added checking of the writable fields of Datatables Editor passed to Django\n- Added information about CSRF authorization to the documentation\n\nVersion 0.2.1 (2019-04-29):\n---------------------------\n\n- Added documentation\n\nVersion 0.2.0 (2019-04-20):\n---------------------------\n\n- Added tests for editor functionality\n\nVersion 0.1.0 (2019-04-15):\n---------------------------\n\n- Initial release.\n- New project released with supporting `Datatables editor `_.\n- The project is based on `django-rest-framework-datatables `_ by `David Jean Louis `_)\n\n---------------------------\n\nVersion 0.5.0 (2019-03-31):\n---------------------------\n\nThe changelog bellow is the changelog of `django-rest-framework-datatables `_ by `David Jean Louis `_)\n\n- Fixed total number of rows when view is using multiple filter back-ends\n- New meta option ``datatables_extra_json`` on view for adding key/value pairs to rendered JSON\n- Minor docs fixes\n\nVersion 0.4.1 (2018-11-16):\n---------------------------\n\n- Added support for Django 2.1 and DRF 3.9\n- Updated README\n\nVersion 0.4.0 (2018-06-22):\n---------------------------\n\n- Added top level filtering for nested serializers\n- Added multiple field filtering\n- Added a ?keep= parameter that allows to bypass the filtering of unused fields\n- Better detection of the requested format\n- Fixed typo in Queryset.count() method name\n\n\nVersion 0.3.0 (2018-05-11):\n---------------------------\n\n- Added a serializer Meta option ``datatables_always_serialize`` that allows to specify a tuple of fields that should always be serialized in the response, regardless of what fields are requested in the Datatables request\n- Optimize filters\n- Use AND operator for column filtering instead of OR, to be consistant with the client-side behavior of Datatables\n\nVersion 0.2.1 (2018-04-11):\n---------------------------\n\n- This version replaces the 0.2.0 who was broken (bad setup.py)\n\nVersion 0.2.0 (2018-04-11):\n---------------------------\n\n- Added full documentation\n- Removed serializers, they are no longer necessary, filtering of columns is made by the renderer\n\nVersion 0.1.0 (2018-04-10):\n---------------------------\n\nInitial release.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/VVyacheslav/django-rest-framework-datatables-editor", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "djangorestframework-datatables-editor", "package_url": "https://pypi.org/project/djangorestframework-datatables-editor/", "platform": "", "project_url": "https://pypi.org/project/djangorestframework-datatables-editor/", "project_urls": { "Homepage": "https://github.com/VVyacheslav/django-rest-framework-datatables-editor" }, "release_url": "https://pypi.org/project/djangorestframework-datatables-editor/0.3.2/", "requires_dist": [ "djangorestframework (>=3.9.1)" ], "requires_python": "", "summary": "Seamless integration between Django REST framework and Datatables (https://datatables.net) with supporting Datatables editor", "version": "0.3.2" }, "last_serial": 5306051, "releases": { "0.2.0": [ { "comment_text": "", "digests": { "md5": "4c74a04475be76d81c41cc4fa5306e31", "sha256": "1347e667ad7335aec574366aef0e406b56544856906eb96302a34209251e12e3" }, "downloads": -1, "filename": "djangorestframework_datatables_editor-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4c74a04475be76d81c41cc4fa5306e31", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 10312, "upload_time": "2019-04-26T14:30:26", "url": "https://files.pythonhosted.org/packages/d2/70/1902facc1561a58731ad5d1c5863f5f7cf8d9de8487f0e5e01e5c6540372/djangorestframework_datatables_editor-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0da3f4bd99355aa7491b0a1fa983263a", "sha256": "729449fe6e758731427b5f603509eb1868cdbb8b2d850cf27393d63ef4bb3d5c" }, "downloads": -1, "filename": "djangorestframework-datatables-editor-0.2.0.tar.gz", "has_sig": false, "md5_digest": "0da3f4bd99355aa7491b0a1fa983263a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11037, "upload_time": "2019-04-26T14:30:29", "url": "https://files.pythonhosted.org/packages/a4/34/cb5349a857fb79e5722b9a4bae4e3c814ec369e66197adcdca215840315e/djangorestframework-datatables-editor-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "0f74f6a11bff8a56d606a4e9a52e06b0", "sha256": "c125639920eef390ee7868aeedc25434874e22fb8491619df466455c3ddb6715" }, "downloads": -1, "filename": "djangorestframework_datatables_editor-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0f74f6a11bff8a56d606a4e9a52e06b0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11011, "upload_time": "2019-04-29T12:06:19", "url": "https://files.pythonhosted.org/packages/9c/21/7672717077d57f743a6aef71567d77c6374a6e02dcae8c20e542eeeaacb7/djangorestframework_datatables_editor-0.2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9e3d6eed7f03665f4ef7a6634536cc35", "sha256": "648e2ec3b8a60e686e55855558be3880bf6ab4f0d1a075df0e2c703260fa444f" }, "downloads": -1, "filename": "djangorestframework-datatables-editor-0.2.1.tar.gz", "has_sig": false, "md5_digest": "9e3d6eed7f03665f4ef7a6634536cc35", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10996, "upload_time": "2019-04-29T12:06:25", "url": "https://files.pythonhosted.org/packages/cc/5d/8d41778ae29b1957db5b0cc18508c72dc4ee3190e96c6dd371dac506a306/djangorestframework-datatables-editor-0.2.1.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "57f4812dceeb974146e22cd64ba7e069", "sha256": "c23e62002c89eb0fbedfd3819a4bc91551955759fbb12fde5e4a51d76cfc009c" }, "downloads": -1, "filename": "djangorestframework_datatables_editor-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "57f4812dceeb974146e22cd64ba7e069", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11439, "upload_time": "2019-05-06T13:27:47", "url": "https://files.pythonhosted.org/packages/2a/03/64e944d707e63c8c526225ced6c157d44e838d5b0d83a732df54dca043ce/djangorestframework_datatables_editor-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2d4a60b28351d6bd4ac2c4fecff01914", "sha256": "c6eb0d0e7f3e930f1b10283dd0209c171a15a24d129d64eadd963f26728341ae" }, "downloads": -1, "filename": "djangorestframework-datatables-editor-0.3.0.tar.gz", "has_sig": false, "md5_digest": "2d4a60b28351d6bd4ac2c4fecff01914", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11488, "upload_time": "2019-05-06T13:27:50", "url": "https://files.pythonhosted.org/packages/aa/85/b5d1907351a8e282843cbdaf12eb4eab534c2c87a56c2b6d6d301a73eeae/djangorestframework-datatables-editor-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "918a3761e770a007ce342e72092345db", "sha256": "5c349f3e504e995869f75f76083dc8a8d6eeced1118b1c0bc3b838b203f37e68" }, "downloads": -1, "filename": "djangorestframework_datatables_editor-0.3.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "918a3761e770a007ce342e72092345db", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11472, "upload_time": "2019-05-22T10:12:21", "url": "https://files.pythonhosted.org/packages/9a/a8/95b208a06288745e58a426197a986619163cc72170ba221689e87c9d3e77/djangorestframework_datatables_editor-0.3.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f8ecd198c9afbc2f5549ca6934f0a044", "sha256": "92ce979ccc03ee3534e27a07c511d7ffac6d0528b944ea0c9e6163d3e9c6ec35" }, "downloads": -1, "filename": "djangorestframework-datatables-editor-0.3.1.tar.gz", "has_sig": false, "md5_digest": "f8ecd198c9afbc2f5549ca6934f0a044", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11488, "upload_time": "2019-05-22T10:12:25", "url": "https://files.pythonhosted.org/packages/58/2c/56166e479b8a9f75177b8ba208115d01889d33bec31d299ae935335de690/djangorestframework-datatables-editor-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "1ee23892b5188873a9ff2ff0d3a2296b", "sha256": "07be8cf3d4a73d3077efa3d5ca0ca3112c33e5f85f9cdb8b957874894c877fd3" }, "downloads": -1, "filename": "djangorestframework_datatables_editor-0.3.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1ee23892b5188873a9ff2ff0d3a2296b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11485, "upload_time": "2019-05-23T06:33:10", "url": "https://files.pythonhosted.org/packages/2f/2b/3f2b317432ce6cf001b1e5848014db01eea3db9e57e607a2deaec91a4cdc/djangorestframework_datatables_editor-0.3.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d444d0588e2ec7d33320870dbe986b16", "sha256": "05b2cd83eb34a075f204b93eda4be7d82becce6a499f7316051b7aa9953220e4" }, "downloads": -1, "filename": "djangorestframework-datatables-editor-0.3.2.tar.gz", "has_sig": false, "md5_digest": "d444d0588e2ec7d33320870dbe986b16", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11532, "upload_time": "2019-05-23T06:33:17", "url": "https://files.pythonhosted.org/packages/30/f9/60084df8b4e40e798601e954173c7a430b2344feda3c1be031e92a86b68b/djangorestframework-datatables-editor-0.3.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1ee23892b5188873a9ff2ff0d3a2296b", "sha256": "07be8cf3d4a73d3077efa3d5ca0ca3112c33e5f85f9cdb8b957874894c877fd3" }, "downloads": -1, "filename": "djangorestframework_datatables_editor-0.3.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1ee23892b5188873a9ff2ff0d3a2296b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11485, "upload_time": "2019-05-23T06:33:10", "url": "https://files.pythonhosted.org/packages/2f/2b/3f2b317432ce6cf001b1e5848014db01eea3db9e57e607a2deaec91a4cdc/djangorestframework_datatables_editor-0.3.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d444d0588e2ec7d33320870dbe986b16", "sha256": "05b2cd83eb34a075f204b93eda4be7d82becce6a499f7316051b7aa9953220e4" }, "downloads": -1, "filename": "djangorestframework-datatables-editor-0.3.2.tar.gz", "has_sig": false, "md5_digest": "d444d0588e2ec7d33320870dbe986b16", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11532, "upload_time": "2019-05-23T06:33:17", "url": "https://files.pythonhosted.org/packages/30/f9/60084df8b4e40e798601e954173c7a430b2344feda3c1be031e92a86b68b/djangorestframework-datatables-editor-0.3.2.tar.gz" } ] }