{ "info": { "author": "Dave Hall", "author_email": "dave@etianen.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python" ], "description": "mohawk-data-platform\n====================\n\n**mohawk-data-platform** is a Django app for editing and publishing arbitrary JSON data in a form-based environment.\n\n\nFeatures\n--------\n\n- Define structured models, with custom fields and validation.\n- Create, edit and update instances defined models using the Django admin interface.\n- Group models into applications for bulk access.\n- Access models, instances and applications via a simple JSON API.\n- Cross-origin API requests via CORS and JSONP.\n\n\nInstallation\n------------\n\n1. Checkout the latest mohawk-data-platform release and copy or symlink the\n ``data`` directory into your ``PYTHONPATH``. If using pip, run \n ``pip install mohawk-data-platform``.\n2. Add ``'data'`` to your ``INSTALLED_APPS`` setting.\n3. Add ``url(r\"^\", include(\"data.urls\", namespace=\"data\")),`` to you ``urls.py`` file.\n4. Install and active the Django admin site, if not already present.\n\n\nAdmin usage\n-----------\n\nThe bulk of the functionality for mohawk-data-platform is found within the admin UI. The basic workflow is:\n\n1. Create a ``Model``, defining at least one ``Field``.\n2. Create an ``Instance`` of that model.\n3. Optionally, create an ``Application``.\n4. Edit the model, and add it to the application you created.\n\nAny data you add to the system will be **pubically-available** via the API endpoints.\n\n\nModel field reference\n---------------------\n\nFields added to a model take a number of optional config parameters, suppled as JSON documents. The available fields, and their configuration options, are listed below.\n\nFields which take choices expect them to be supplied as a list of ``[value, label]`` options::\n\n {\n \"choices\": [\n [\"#ff0000\", \"Red\"],\n [\"#0000ff\", \"Green\"],\n [\"#00ff00\", \"Blue\"]\n ]\n }\n\n\nText\n^^^^\n\nA single-line of unicode text.\n\n::\n\n {\n \"required\": true,\n \"choices\": null\n }\n\n\nInteger\n^^^^^^^\n\nAn integer number.\n\n::\n\n {\n \"required\": true,\n \"choices\": null\n }\n\n\nFloat\n^^^^^\n\nA floating-point number.\n\n::\n\n {\n \"required\": true\n }\n\n\nDate\n^^^^\n\nA date value.\n\n::\n\n {\n \"required\": true\n }\n\n\nTime\n^^^^\n\nA time value.\n\n::\n\n {\n \"required\": true\n }\n\n\nDatetime\n^^^^^^^^\n\nA combined date and time value.\n\n::\n\n {\n \"required\": true\n }\n\n\nBoolean\n^^^^^^^\n\nA true/false checkbox.\n\n::\n\n {}\n\n\nFile\n^^^^\n\nAn uploaded file.\n\n::\n\n {\n \"required\": true\n }\n\n\nLong text\n^^^^^^^^^\n\nMultiple lines of unicode text.\n\n::\n\n {\n \"required\": true\n }\n\n\nModel\n^^^^^\n\nA reference to an instance of a model.\n\n::\n\n {\n \"required\": true,\n \"model_id\": \"\" // The type of instance being referenced.\n }\n\n\nMulti model\n^^^^^^^^^^^\n\nA reference to multiple instances of a model.\n\n::\n\n {\n \"required\": true,\n \"model_id\": \"\" // The type of instance being referenced.\n }\n\n\nAPI endpoints\n-------------\n\n\nGET /.json\n^^^^^^^^^^^^^^^^^^^^\n\nReturns all online instances of the given model::\n\n {\n \"status\": \"OK\",\n \"message\": \"Instances of Your Model were successfully loaded.\",\n \"instances\": [\n {\n \"_date_created\": \"\",\n \"_date_modified\": \"\",\n \"_id\": \"\",\n \"_model\": \"\",\n \"\": \"\",\n ...\n },\n ...\n ]\n }\n\n\nGET //.json\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nReturns the given instance::\n\n {\n \"status\": \"OK\",\n \"message\": \"Instances of were successfully loaded.\",\n \"instance\": {\n \"_date_created\": \"\",\n \"_date_modified\": \"\",\n \"_id\": \"\",\n \"_model\": \"\",\n \"\": \"\",\n ...\n }\n }\n\n\nGET /a/.json\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nReturns all online instances within the given application::\n\n {\n \"status\": \"OK\",\n \"message\": \"Instances within application were successfully loaded.\",\n \"instances\": [\n {\n \"_date_created\": \"\",\n \"_date_modified\": \"\",\n \"_id\": \"\",\n \"_model\": \"\",\n \"\": \"\",\n ...\n },\n ...\n ]\n }\n\n\n\nMore information\n----------------\n\nThe mohawk-data-platform project was developed at `Mohawk `_, and\nis released as Open Source under the MIT license.\n\nYou can get the code from the `mohawk-data-platform project site `_.\n\n\nContributors\n------------\n\nThe following people were involved in the development of this project.\n\n- Dave Hall - `Blog `_ | `GitHub `_ | `Twitter `_ | `Google Profile `_", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/mohawkhq/mohawk-data-platform", "keywords": null, "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "mohawk-data-platform", "package_url": "https://pypi.org/project/mohawk-data-platform/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/mohawk-data-platform/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/mohawkhq/mohawk-data-platform" }, "release_url": "https://pypi.org/project/mohawk-data-platform/0.9.3/", "requires_dist": null, "requires_python": null, "summary": "A Django app for editing and publishing arbitrary JSON data in a form-based environment.", "version": "0.9.3" }, "last_serial": 1051243, "releases": { "0.9.0": [ { "comment_text": "", "digests": { "md5": "4ea555f85a25bbd573619d995b5b233b", "sha256": "dc4e25abb8146ac58f7dbe3914575e3e3a941ab8cdfb30da9f27e664fc37f965" }, "downloads": -1, "filename": "mohawk-data-platform-0.9.0.tar.gz", "has_sig": false, "md5_digest": "4ea555f85a25bbd573619d995b5b233b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17017, "upload_time": "2013-12-04T17:23:42", "url": "https://files.pythonhosted.org/packages/7b/12/cc636b9038c6705965a8c03347444a519fd59d2170e917514e11c327269f/mohawk-data-platform-0.9.0.tar.gz" } ], "0.9.1": [ { "comment_text": "", "digests": { "md5": "ff2833080a7b9eba246334fbaaca5ad9", "sha256": "49e7deceb3fcfadd1ddd7a43848de4ed328886e8233fe267b02c207774d5e37c" }, "downloads": -1, "filename": "mohawk-data-platform-0.9.1.tar.gz", "has_sig": false, "md5_digest": "ff2833080a7b9eba246334fbaaca5ad9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17083, "upload_time": "2014-01-13T11:53:04", "url": "https://files.pythonhosted.org/packages/c8/01/5c169188fa1e953ddd690e5cdd503331b2a0cc7eac7a72c29cbac49f129f/mohawk-data-platform-0.9.1.tar.gz" } ], "0.9.2": [ { "comment_text": "", "digests": { "md5": "9413044ae47668188e6c376a5899173c", "sha256": "820960c30d6105b79703d0b925b3ab6bce61d4c4a4c11bcb17dfd886ce2f3190" }, "downloads": -1, "filename": "mohawk-data-platform-0.9.2.tar.gz", "has_sig": false, "md5_digest": "9413044ae47668188e6c376a5899173c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17186, "upload_time": "2014-03-16T21:10:20", "url": "https://files.pythonhosted.org/packages/e9/3a/af73a922b285d94139a589b99176b29dcad1dc5922b550e982ed8d155923/mohawk-data-platform-0.9.2.tar.gz" } ], "0.9.3": [ { "comment_text": "", "digests": { "md5": "1e7b267f2ac56e0286dbe20312d15ee6", "sha256": "c4a8b130068f8237cb48e6bafef593e0bb3365c20be6de75c36d777e91d80242" }, "downloads": -1, "filename": "mohawk-data-platform-0.9.3.tar.gz", "has_sig": false, "md5_digest": "1e7b267f2ac56e0286dbe20312d15ee6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17225, "upload_time": "2014-04-04T11:01:30", "url": "https://files.pythonhosted.org/packages/7b/2c/c0fe7b8a22e1a9482ffdbd23298b8951fe80c0f1d06f73c1e459bc2adfe3/mohawk-data-platform-0.9.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1e7b267f2ac56e0286dbe20312d15ee6", "sha256": "c4a8b130068f8237cb48e6bafef593e0bb3365c20be6de75c36d777e91d80242" }, "downloads": -1, "filename": "mohawk-data-platform-0.9.3.tar.gz", "has_sig": false, "md5_digest": "1e7b267f2ac56e0286dbe20312d15ee6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17225, "upload_time": "2014-04-04T11:01:30", "url": "https://files.pythonhosted.org/packages/7b/2c/c0fe7b8a22e1a9482ffdbd23298b8951fe80c0f1d06f73c1e459bc2adfe3/mohawk-data-platform-0.9.3.tar.gz" } ] }