Metadata-Version: 1.2
Name: marknote
Version: 1.0.0
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.
Home-page: https://github.com/sheldonkwoodward/marknote
Author: Sheldon Woodward
Author-email: contact@sheldonw.com
License: MIT
Description: MarkNote
        --------
        |Build Status|
        |Codacy Quality Badge|
        |Codacy Coverage Badge|
        
        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.
        
        Installation
        ============
        1. Install with pip.
        
        ::
        
            $ pip install marknote
        
        2. Modify your ``INSTALLED_APPS`` in settings.py.
        
        ::
        
            INSTALLED_APPS = [
                'rest_framework',
                'rest_framework.authtoken',
                'marknote',
            ]
        
        3. Modify you ``urlpatterns`` in urls.py.
        
        ::
        
            from django.urls import include, re_path
        
            urlpatterns = [
                re_path(r'^marknote/', include(('marknote.urls', 'marknote'), namespace='marknote'))
            ]
        
        Endpoints
        =========
        Documentation can be found `here <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/sheldonkwoodward/marknote/master/docs/marknote.yml#//>`_. Refer to the ``docs`` folder for the OpenAPI specification file.
        
        There are four different endpoints for the API. The ``marknote`` portion of the URI can be mapped using the Django urls.py file. It is setup as shown in the sample project.
        
        /marknote/note
          The create and list endpoint used to create and list all notes.
        
        /marknote/note/{id}
          The retrieve, update, and destroy endpoint used to access individual notes.
        
        /marknote/folder
          The create and list endpoint used to create and list all folders.
        
        /marknote/folder/{id}
          The retrieve, update, and destroy endpoint used to access individual folders.
          
        Tests
        =====
        To run the unit tests, simply use the Django test command with Pipenv.
        
        ::
        
            $ pipenv run python manage.py test
        
        
        .. |Build Status| image:: https://travis-ci.org/sheldonkwoodward/marknote.svg?branch=master
            :target: https://travis-ci.org/sheldonkwoodward/marknote
        
        .. |Codacy Quality Badge| image:: https://api.codacy.com/project/badge/Grade/171d5b34125f45e6970a10806dc0ea02
            :target: https://www.codacy.com/app/sheldonkwoodward/marknote?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=sheldonkwoodward/marknote&amp;utm_campaign=Badge_Grade
        
        .. |Codacy Coverage Badge| image:: https://api.codacy.com/project/badge/Coverage/171d5b34125f45e6970a10806dc0ea02
            :target: https://www.codacy.com/app/sheldonkwoodward/marknote?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=sheldonkwoodward/marknote&amp;utm_campaign=Badge_Coverage
        
Keywords: django rest api notes
Platform: UNKNOWN
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Intended Audience :: Developers
Classifier: License :: Public Domain
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=3.5
