upgrading draceditor to martor

Author: agusmakmun

.gitignore

@@ -0,0 +1,7 @@
+__pycache__
+build/
+dist/
+*.egg-info/
+*.pypirc
+*.pyc
+*backup*

LICENSE

@@ -0,0 +1,5 @@
+include LICENSE
+include README.md
+include requirements.txt
+recursive-include martor/templates *
+recursive-include martor/static *

MANIFEST.in

@@ -0,0 +1,254 @@
+martor |pypi version|
+------------------------------
+
+.. |pypi version|
+   image:: https://img.shields.io/pypi/v/martor.svg?style=flat-square
+   :target: https://pypi.python.org/pypi/martor
+
+.. image:: https://img.shields.io/badge/license-GNUGPLv3-blue.svg?style=flat-square
+   :target: https://raw.githubusercontent.com/agusmakmun/django-markdown-editor/master/LICENSE
+
+.. image:: https://img.shields.io/pypi/pyversions/martor.svg?style=flat-square
+   :target: https://pypi.python.org/pypi/martor
+
+.. image:: https://img.shields.io/badge/Django-1.8,%201.9,%201.10-green.svg?style=flat-square
+  :target: https://www.djangoproject.com
+
+.. image:: https://img.shields.io/pypi/dm/martor.svg?style=flat-square
+   :target: https://pypi.python.org/pypi/martor
+
+
+**Martor** is a Django Markdown Editor and new face of **DracEditor**.
+
+
+Features
+------------------------------
+
+* Integrated with `Ace Editor`_
+* Integrated with `Semantic-UI`_
+* Live Preview
+* Support Multiple Fields (`fixed this issue`_)
+* Upload Image to imgur.com `(via API)`
+* Emoji ``:emoji_name:`` + Cheat sheet
+* Direct Mention users ``@[username]`` - `(require user to logged in)`
+* Highlight ``pre``
+* Django Admin support
+* Toolbar Buttons
+
+
+Preview
+------------------------------
+
+.. image:: https://raw.githubusercontent.com/agusmakmun/django-markdown-editor/master/__screenshot/martor-preview-editor.png
+
+.. image:: https://raw.githubusercontent.com/agusmakmun/django-markdown-editor/master/__screenshot/martor-preview-result.png
+
+
+Requirements
+------------------------------
+
+* ``Django>=1.10.1``
+* ``Markdown>=2.6.7``
+* ``requests>=2.12.4``
+
+
+Installation
+------------------------------
+
+Martor is available directly from `PyPI`_:
+
+1. Installing the package.
+
+::
+
+    $ pip install martor
+
+
+2. Don't forget to add ``'martor'`` to your ``'INSTALLED_APPS'`` setting `(without migrations)`.
+
+::
+
+    # settings.py
+    INSTALLED_APPS = [
+        ....
+        'martor',
+    ]
+
+
+3. Add url pattern to your ``urls.py.``
+
+::
+
+    # urls.py
+    urlpatterns = [
+        ...
+        url(r'^martor/', include('martor.urls')),
+    ]
+
+
+4. Collect included some martor static files to your ``STATIC_ROOT`` folder.
+
+::
+
+    ./manage.py collectstatic
+
+
+Setting Configurations ``settings.py``
+---------------------------------------
+
+Please register application in https://api.imgur.com/oauth2/addclient
+to get ``IMGUR_CLIENT_ID`` and ``IMGUR_API_KEY``.
+
+::
+
+    # Global martor settings
+    # Input: string boolean, `true/false`
+    MARTOR_ENABLE_CONFIGS' = {
+        'imgur': 'true',     # to enable/disable imgur/custom uploader.
+        'mention': 'false',  # to enable/disable mention
+        'jquery': 'true',    # to include/revoke jquery (require for admin default django)
+    }
+
+    # Imgur API Keys
+    MARTOR_IMGUR_CLIENT_ID = 'your-client-id'
+    MARTOR_IMGUR_API_KEY   = 'your-api-key'
+
+    # Safe Mode
+    MARTOR_MARKDOWN_SAFE_MODE = True # default
+
+    # Markdownify
+    MARTOR_MARKDOWNIFY_FUNCTION = 'martor.utils.markdownify' # default
+    MARTOR_MARKDOWNIFY_URL = '/martor/markdownify/' # default
+
+    # Markdown extensions (default)
+    MARTOR_MARKDOWN_EXTENSIONS = [
+        'markdown.extensions.extra',
+        'markdown.extensions.nl2br',
+        'markdown.extensions.smarty',
+        'markdown.extensions.fenced_code',
+
+        # Custom markdown extensions.
+        'martor.extensions.urlize',
+        'martor.extensions.del_ins', # ~~strikethrough~~ and ++underscores++
+        'martor.extensions.mention', # require for mention
+        'martor.extensions.emoji',   # require for emoji
+    ]
+
+    # Markdown Extensions Configs
+    MARTOR_MARKDOWN_EXTENSION_CONFIGS = {}
+
+    # Markdown urls
+    MARTOR_UPLOAD_URL = '/martor/uploader/' # default
+    MARTOR_SEARCH_USERS_URL = '/martor/search-user/' # default
+
+    # Markdown Extensions
+    MARTOR_MARKDOWN_BASE_EMOJI_URL = 'https://assets-cdn.github.com/images/icons/emoji/' # default
+    MARTOR_MARKDOWN_BASE_MENTION_URL = 'https://python.web.id/profile/' # default (change this)
+
+Check this setting is not set else csrf will not be sent over ajax calls:
+
+::
+
+    CSRF_COOKIE_HTTPONLY = False
+
+
+Usage
+------------------------------
+
+**Model**
+
+::
+
+    from django.db import models
+    from martor.models import MartorField
+
+    class Post(models.Model):
+        description = MartorField()
+
+
+**Form**
+
+::
+
+    from django import forms
+    from martor.fields import MartorFormField
+
+    class PostForm(forms.Form):
+        description = MartorFormField()
+
+
+**Admin**
+
+::
+
+    from django.db import models
+    from django.contrib import admin
+
+    from martor.widgets import AdminMartorWidget
+
+    from yourapp.models import YourModel
+
+    class YourModelAdmin(admin.ModelAdmin):
+        formfield_overrides = {
+            models.TextField: {'widget': AdminMartorWidget},
+        }
+
+    admin.site.register(YourModel, YourModelAdmin)
+
+
+**Template**
+
+Simply safe the markdown content as html ouput with loading the templatetags from ``martor/templatetags/martortags.py``.
+
+::
+
+    {% load martortags %}
+    {{ field_name|safe_markdown }}
+
+    # example
+    {{ post.description|safe_markdown }}
+
+
+Custom Uploader
+-----------------
+
+If you want to save the images uploaded to your storage,
+**Martor** also provide to handle it. Please checkout this `WIKI`_.
+
+Test the Martor from this Repository
+-------------------------------------
+
+I assume you already setup with virtual enviroment (virtualenv).
+
+::
+
+    $ git clone https://github.com/agusmakmun/django-markdown-editor.git
+    $ cd django-markdown-editor/ && python setup.py install
+    $ cd martor_demo/
+    $ python manage.py makemigrations && python manage.py migrate
+    $ python manage.py runserver
+
+
+And let checkout at http://127.0.0.1:8000/simple-form/ to your browser.
+
+
+Martor Commands Refference
+--------------------------------
+
+.. image:: https://raw.githubusercontent.com/agusmakmun/django-markdown-editor/master/__screenshot/martor-guide.png
+
+
+Notes
+--------------------------------
+
+**Martor** was inspired by great `django-markdownx`_, `Python Markdown`_ and `Online reStructuredText editor`_.
+
+
+.. _Ace Editor: https://ace.c9.io
+.. _Semantic-UI: http://semantic-ui.com
+.. _PyPI: https://pypi.python.org/pypi/martor
+.. _django-markdownx: https://github.com/adi-/django-markdownx
+.. _Python Markdown: https://github.com/waylan/Python-Markdown
+.. _Online reStructuredText editor: http://rst.ninjs.org
+.. _WIKI: https://github.com/agusmakmun/django-markdown-editor/wiki
+.. _fixed this issue: https://github.com/agusmakmun/django-markdown-editor/issues/3

README.rst

@@ -0,0 +1,10 @@
+certifi==2017.7.27.1
+chardet==3.0.4
+Django==1.11.5
+draceditor==1.1.7
+idna==2.6
+Markdown==2.6.9
+pkg-resources==0.0.0
+pytz==2017.2
+requests==2.18.4
+urllib3==1.22

__screenshot/martor-preview-editor.png

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+
+__VERSION__ = '1.2.0'
+__AUTHOR__ = 'Agus Makmun (Summon Agus)'
+__AUTHOR_EMAIL__ = '[email protected]'

__screenshot/martor-preview-result.png

@@ -0,0 +1,12 @@
+from django.contrib import admin
+from django.db import models
+
+from .widgets import AdminMartorWidget
+from .models import MartorField
+
+
+class MartorModelAdmin(admin.ModelAdmin):
+
+    formfield_overrides = {
+        MartorField: {'widget': AdminMartorWidget}
+    }

foob.txt

@@ -0,0 +1,54 @@
+import json
+import base64
+import requests
+from .settings import (MARTOR_IMGUR_CLIENT_ID, MARTOR_IMGUR_API_KEY)
+
+requests.packages.urllib3.disable_warnings()
+
+
+def imgur_uploader(image):
+    """
+    Basic imgur uploader return as json data.
+    :param `image` is from `request.FILES['markdown-image-upload']`
+
+    Return:
+        success: {'status': 200, 'link': <link_image>, 'name': <image_name>}
+        error  : {'status': <error_code>, 'erorr': <erorr_message>}
+    """
+    url_api = 'https://api.imgur.com/3/upload.json'
+    headers = {'Authorization': 'Client-ID ' + MARTOR_IMGUR_CLIENT_ID}
+    response = requests.post(
+        url_api,
+        headers=headers,
+        data={
+            'key': MARTOR_IMGUR_API_KEY,
+            'image': base64.b64encode(image.read()),
+            'type': 'base64',
+            'name': image.name
+        }
+    )
+
+    """
+    Some function we got from `response`:
+
+    ['connection', 'content', 'cookies', 'elapsed', 'encoding', 'headers','history',
+    'is_permanent_redirect', 'is_redirect', 'iter_content', 'iter_lines', 'json',
+    'links', 'ok', 'raise_for_status', 'raw', 'reason', 'request', 'status_code', 'text', 'url']
+    """
+    if response.status_code == 200:
+        respdata = json.loads(response.content.decode('utf-8'))
+        return json.dumps({
+            'status': respdata['status'],
+            'link': respdata['data']['link'],
+            'name': respdata['data']['name']
+        })
+    elif response.status_code == 415:
+        # Unsupport File type
+        return json.dumps({
+            'status': response.status_code,
+            'error': response.reason
+        })
+    return json.dumps({
+        'status': response.status_code,
+        'error': response.content.decode('utf-8')
+    })