{ "info": { "author": "Sheldon Woodward", "author_email": "contact@sheldonw.com", "bugtrack_url": null, "classifiers": [ "Framework :: Django :: 2.0", "Framework :: Django :: 2.1", "Intended Audience :: Developers", "License :: Public Domain", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Internet :: WWW/HTTP" ], "description": "MarkNote\n--------\n|PyPI Version|\n|Python Versions|\n|Django Versions|\n|License|\n|Build Status|\n|Codacy Quality Badge|\n|Codacy Coverage Badge|\n\nA simple note taking API for Django that supports creating notes and a folder structure. Built for the purpose of\nlearning how to use the Django REST Framework to build a CRUD API.\n\nFeatures\n--------\n- Notes and folder structure\n- Per item owners\n- Integrated Django permissions\n\n**Planned Features**\n\n- Revision history\n- Bearer token support\n- Note sharing\n- Ownership transfer\n\nInstallation\n------------\n1. Install with pip.\n\n::\n\n $ pip install marknote\n\n2. Modify your ``INSTALLED_APPS`` in settings.py.\n\n::\n\n INSTALLED_APPS = [\n 'rest_framework',\n 'rest_framework.authtoken',\n 'marknote',\n ]\n\n3. Modify you ``urlpatterns`` in urls.py.\n\n::\n\n from django.urls import include, re_path\n\n urlpatterns = [\n re_path(r'^marknote/', include(('marknote.urls', 'marknote'), namespace='marknote'))\n ]\n\n4. Run migrations.\n\n::\n\n $ python manage.py migrate\n\n5. In the Django admin panel, generate a new token for the desired user. If they are not a superuser then they will\nneed the MarkNote permissions added to their user.\n\nThe request expects an ``Authorization`` header with the value of ``Token xxx`` where ``xxx`` is your token. This\nwill be changed in the future to add Bearer token support.\n\nEndpoints\n---------\nDocumentation can be found `here `_. Refer to the\n``docs`` folder for the OpenAPI specification file.\n\nThere are four different endpoints for the API. The ``marknote`` portion of the URI can be mapped using the Django\nurls.py file. It is setup as shown in the sample project.\n\n/marknote/note\n The create and list endpoint used to create and list all notes.\n\n/marknote/note/{id}\n The retrieve, update, and destroy endpoint used to access individual notes.\n\n/marknote/folder\n The create and list endpoint used to create and list all folders.\n\n/marknote/folder/{id}\n The retrieve, update, and destroy endpoint used to access individual folders.\n\nTests\n-----\nTo run the unit tests, simply use the Django test command with Pipenv.\n\n::\n\n $ pipenv install\n $ pipenv run python manage.py test\n\n\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/marknote.svg\n :target: https://pypi.org/project/marknote/\n\n.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/marknote.svg\n\n.. |Django Versions| image:: https://img.shields.io/pypi/djversions/marknote.svg\n\n.. |License| image:: https://img.shields.io/github/license/sheldonkwoodward/marknote.svg\n :target: https://github.com/sheldonkwoodward/marknote/LICENSE.txt\n\n.. |Build Status| image:: https://travis-ci.org/sheldonkwoodward/marknote.svg?branch-master\n :target: https://travis-ci.org/sheldonkwoodward/marknote\n\n.. |Codacy Quality Badge| image:: https://api.codacy.com/project/badge/Grade/171d5b34125f45e6970a10806dc0ea02\n :target: https://www.codacy.com/app/sheldonkwoodward/marknote?utm_source-github.com&utm_medium-referral&utm_content-sheldonkwoodward/marknote&utm_campaign-Badge_Grade\n\n.. |Codacy Coverage Badge| image:: https://api.codacy.com/project/badge/Coverage/171d5b34125f45e6970a10806dc0ea02\n :target: https://www.codacy.com/app/sheldonkwoodward/marknote?utm_source-github.com&utm_medium-referral&utm_content-sheldonkwoodward/marknote&utm_campaign-Badge_Coverage\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/sheldonkwoodward/marknote", "keywords": "django rest api notes", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "marknote", "package_url": "https://pypi.org/project/marknote/", "platform": "", "project_url": "https://pypi.org/project/marknote/", "project_urls": { "Homepage": "https://github.com/sheldonkwoodward/marknote" }, "release_url": "https://pypi.org/project/marknote/1.0.2/", "requires_dist": [ "django", "djangorestframework" ], "requires_python": ">=3.5", "summary": "A simple note taking API for Django that supports creating notes and a folder structure. Built for the purpose of learning how to use the Django REST Framework to build a CRUD API.", "version": "1.0.2" }, "last_serial": 4248267, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "70fe64c9b46a4eba87bf7a7fe196108f", "sha256": "8beb13a72f7cb27052e28acc94f85fc8eb7f15c854ab964015a110a9a36174fc" }, "downloads": -1, "filename": "marknote-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "70fe64c9b46a4eba87bf7a7fe196108f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 10969, "upload_time": "2018-09-07T00:49:58", "url": "https://files.pythonhosted.org/packages/1d/0a/15e5426e534cff2a1e08b461257444043d27577006375abc1d91afae0376/marknote-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6955c7a24484764b4b255f07f4f41797", "sha256": "b075303cb3cb2b3d8ed7ef7db23ce73df639ea05201addd2294e27959f5a7b7d" }, "downloads": -1, "filename": "marknote-1.0.0.tar.gz", "has_sig": false, "md5_digest": "6955c7a24484764b4b255f07f4f41797", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 8910, "upload_time": "2018-09-07T00:49:59", "url": "https://files.pythonhosted.org/packages/4f/31/78b1059f00bc27f9788fc36466cc58fda99eacbeeb50f7f8762582588fd2/marknote-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "f88e22664dbd0b0aa4c1128a7f38c460", "sha256": "036a6764041172f8561acb208d3ec607278b3a7a643c0020b250c01a5d515009" }, "downloads": -1, "filename": "marknote-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "f88e22664dbd0b0aa4c1128a7f38c460", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 11156, "upload_time": "2018-09-07T02:03:33", "url": "https://files.pythonhosted.org/packages/9e/d2/48c65df788275a5437d8648f7646d8731f82447a63218f30b1ccde68c63f/marknote-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "71a9568fd9b75580a837235b3e121409", "sha256": "78cf1456d2bf68446048d80fa372f1b06889e928fd9ab533e71415a7f768b468" }, "downloads": -1, "filename": "marknote-1.0.1.tar.gz", "has_sig": false, "md5_digest": "71a9568fd9b75580a837235b3e121409", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 9374, "upload_time": "2018-09-07T02:03:34", "url": "https://files.pythonhosted.org/packages/92/82/ba6fc823d6985a012ae1be2fd2331836de6bc2d6a9d7b54054c58230a735/marknote-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "7f54df277ebdb051e35c703712651040", "sha256": "7fb0a70b106494d7e9e2ef0874151b5d13d8b9331cafb060a5d1ea76814b5fc5" }, "downloads": -1, "filename": "marknote-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "7f54df277ebdb051e35c703712651040", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 11346, "upload_time": "2018-09-07T12:24:10", "url": "https://files.pythonhosted.org/packages/03/78/7996f3a616c281b1446f7d67ae9b00348b9fe8fa7e68881a43640e7ccd6f/marknote-1.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7bd423f2f759cf9bee501f3e8dd304ba", "sha256": "41f6e29aa7b25cec35240be0056c94df10c14d1491803ca415bbf9dcd3d191c6" }, "downloads": -1, "filename": "marknote-1.0.2.tar.gz", "has_sig": false, "md5_digest": "7bd423f2f759cf9bee501f3e8dd304ba", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 9858, "upload_time": "2018-09-07T12:24:12", "url": "https://files.pythonhosted.org/packages/fa/ed/a5afbf88eea380f3e9ed7920aa6f121340c6b3f7707a0c8ee88e444fcee3/marknote-1.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7f54df277ebdb051e35c703712651040", "sha256": "7fb0a70b106494d7e9e2ef0874151b5d13d8b9331cafb060a5d1ea76814b5fc5" }, "downloads": -1, "filename": "marknote-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "7f54df277ebdb051e35c703712651040", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 11346, "upload_time": "2018-09-07T12:24:10", "url": "https://files.pythonhosted.org/packages/03/78/7996f3a616c281b1446f7d67ae9b00348b9fe8fa7e68881a43640e7ccd6f/marknote-1.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7bd423f2f759cf9bee501f3e8dd304ba", "sha256": "41f6e29aa7b25cec35240be0056c94df10c14d1491803ca415bbf9dcd3d191c6" }, "downloads": -1, "filename": "marknote-1.0.2.tar.gz", "has_sig": false, "md5_digest": "7bd423f2f759cf9bee501f3e8dd304ba", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 9858, "upload_time": "2018-09-07T12:24:12", "url": "https://files.pythonhosted.org/packages/fa/ed/a5afbf88eea380f3e9ed7920aa6f121340c6b3f7707a0c8ee88e444fcee3/marknote-1.0.2.tar.gz" } ] }