{ "info": { "author": "Michael F. Covington", "author_email": "mfcovington@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.11", "Framework :: Django :: 2.0", "Framework :: Django :: 2.1", "Intended Audience :: Science/Research", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only", "Topic :: Documentation", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Dynamic Content" ], "description": "**************************\ndjango-markupfield-helpers\n**************************\n\n``django-markupfield-helpers`` is a set of Django helpers that make it easier to get up and running quickly with ``django-markupfield``.\n\nSource code is available on GitHub at `mfcovington/django-markupfield-helpers `_. Information about ``django-markupfield`` is available on `GitHub `_.\n\n\n.. contents:: :local:\n\n\nInstallation\n============\n\n**PyPI**\n\n.. code-block:: sh\n\n pip install django-markupfield-helpers\n\n\n**GitHub (development branch)**\n\n.. code-block:: sh\n\n pip install git+http://github.com/mfcovington/django-markupfield-helpers.git@develop\n\n\nConfiguration\n=============\n\nAdd ``markupfield_helpers`` to ``INSTALLED_APPS`` in ``settings.py``:\n\n.. code-block:: python\n\n INSTALLED_APPS = (\n ...\n 'markupfield_helpers',\n )\n\n\nAdd a link to the CSS file for syntax highlighting in ``base.html`` or in a specific template.\n\n.. code-block:: python\n\n {% load staticfiles %}\n\n \n\n\n``markupfield_helpers`` can be left out of ``INSTALLED_APPS`` if the provided CSS for syntax highlighting is not needed.\n\n\nHelpers\n=======\n\n``MarkupField``\n---------------\n\nThe ``MarkupField`` class from ``markupfield_helpers`` can be used in place of the class of the same name from ``markupfield``.\n\nThe ``markupfield_helpers`` version comes with four markup types defined:\n\n- ``Markdown`` (**Default**): Markdown 2 with extras (``code-friendly``, ``cuddled-lists``, ``fenced-code-blocks``, ``footnotes``, and ``tables``)\n- ``Markdown Basic``: Markdown 2 without extras\n- ``Plain Text``\n- ``reStructuredText``\n\n\nHere is a basic example of how to use the ``markupfield_helpers`` version of ``MarkupField``:\n\n.. code-block:: python\n\n from django.db import models\n from markupfield_helpers.helpers import MarkupField\n\n class Article(models.Model):\n title = models.CharField(max_length=100)\n slug = models.SlugField(max_length=100)\n body = MarkupField()\n\n\n``MARKUP_FIELD_TYPES``\n----------------------\n\nAlternatively, ``MARKUP_FIELD_TYPES`` can be imported from ``markupfield_helpers.helpers`` and used as-is or modified.\nThis is equivalent to the code above:\n\n\n.. code-block:: python\n\n from django.db import models\n from markupfield.fields import MarkupField\n from markupfield_helpers.helpers import MARKUP_FIELD_TYPES\n\n\n class Article(models.Model):\n title = models.CharField(max_length=100)\n slug = models.SlugField(max_length=100)\n body = MarkupField(\n default_markup_type='Markdown',\n markup_choices=MARKUP_FIELD_TYPES,\n )\n\n\nIssues\n======\n\nIf you experience any problems or would like to request a feature, please `create an issue `_ on GitHub.\n\n\n*Version 0.1.1*\n\n\nRevision History\n================\n\n0.1.0 2018-12-01\n\n- A set of Django helpers that make it easier to get up and running quickly with ``django-markupfield``\n\n\n0.1.1 2018-12-01\n\n- Fix manifest to include static CSS file\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/mfcovington/django-markupfield-helpers", "keywords": "markup markdown", "license": "BSD License", "maintainer": "", "maintainer_email": "", "name": "django-markupfield-helpers", "package_url": "https://pypi.org/project/django-markupfield-helpers/", "platform": "", "project_url": "https://pypi.org/project/django-markupfield-helpers/", "project_urls": { "Homepage": "https://github.com/mfcovington/django-markupfield-helpers" }, "release_url": "https://pypi.org/project/django-markupfield-helpers/0.1.1/", "requires_dist": [ "Django (>=1.11)", "django-markupfield (>=1.3.5)", "docutils (>=0.12)", "markdown2 (>=2.3.0)", "Pygments (>=2.0.2)" ], "requires_python": "", "summary": "A set of Django helpers that make it easier to get up and running quickly with django-markupfield", "version": "0.1.1" }, "last_serial": 4551392, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "f51faa7b3514e0d71db53b7a3bef60b7", "sha256": "a52d1a597fa896d36cd2a4cce5d9e03053627ec8a83ad080a0426fb93511a509" }, "downloads": -1, "filename": "django_markupfield_helpers-0.1.0-py33-none-any.whl", "has_sig": false, "md5_digest": "f51faa7b3514e0d71db53b7a3bef60b7", "packagetype": "bdist_wheel", "python_version": "py33", "requires_python": null, "size": 5655, "upload_time": "2018-12-02T01:26:24", "url": "https://files.pythonhosted.org/packages/46/9b/b975eec883cfe26a7fb0a129b5583f01988f18caf932bd1f27bd1302575c/django_markupfield_helpers-0.1.0-py33-none-any.whl" }, { "comment_text": "", "digests": { "md5": "14467770138c5707b1eb970ac217cb18", "sha256": "16560534cfb32eee38785365e4499506820e0ca735c675036ca3dc14f8330abb" }, "downloads": -1, "filename": "django-markupfield-helpers-0.1.0.tar.gz", "has_sig": false, "md5_digest": "14467770138c5707b1eb970ac217cb18", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4667, "upload_time": "2018-12-02T01:26:27", "url": "https://files.pythonhosted.org/packages/66/bb/40ccc6aad67fc52bbb4dfaf5d46620a15cfccc1909ee2ec2add51ace73f3/django-markupfield-helpers-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "9eea7ed07c82db4a0f8ba2692dc94d51", "sha256": "517bb696443658ca06982e84f821e87756c8d3ab907cd39f1bc1ee035076f1cd" }, "downloads": -1, "filename": "django_markupfield_helpers-0.1.1-py33-none-any.whl", "has_sig": false, "md5_digest": "9eea7ed07c82db4a0f8ba2692dc94d51", "packagetype": "bdist_wheel", "python_version": "py33", "requires_python": null, "size": 6761, "upload_time": "2018-12-02T02:00:41", "url": "https://files.pythonhosted.org/packages/fe/7c/820aa70f584e407c63bd3c4d9bc116eadeac9298bb30ef92865a022c1fb0/django_markupfield_helpers-0.1.1-py33-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d05a99727b191b773aa3b44028204663", "sha256": "970c5bb6187640c6c281879b9da087d326ef56a2347e8d9652396f9d5194cdca" }, "downloads": -1, "filename": "django-markupfield-helpers-0.1.1.tar.gz", "has_sig": false, "md5_digest": "d05a99727b191b773aa3b44028204663", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5607, "upload_time": "2018-12-02T02:00:43", "url": "https://files.pythonhosted.org/packages/76/b6/bed8efeb81ec2941a3603ffdbf5883c92fc7ef6078e09d7ab1b2b507828b/django-markupfield-helpers-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9eea7ed07c82db4a0f8ba2692dc94d51", "sha256": "517bb696443658ca06982e84f821e87756c8d3ab907cd39f1bc1ee035076f1cd" }, "downloads": -1, "filename": "django_markupfield_helpers-0.1.1-py33-none-any.whl", "has_sig": false, "md5_digest": "9eea7ed07c82db4a0f8ba2692dc94d51", "packagetype": "bdist_wheel", "python_version": "py33", "requires_python": null, "size": 6761, "upload_time": "2018-12-02T02:00:41", "url": "https://files.pythonhosted.org/packages/fe/7c/820aa70f584e407c63bd3c4d9bc116eadeac9298bb30ef92865a022c1fb0/django_markupfield_helpers-0.1.1-py33-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d05a99727b191b773aa3b44028204663", "sha256": "970c5bb6187640c6c281879b9da087d326ef56a2347e8d9652396f9d5194cdca" }, "downloads": -1, "filename": "django-markupfield-helpers-0.1.1.tar.gz", "has_sig": false, "md5_digest": "d05a99727b191b773aa3b44028204663", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5607, "upload_time": "2018-12-02T02:00:43", "url": "https://files.pythonhosted.org/packages/76/b6/bed8efeb81ec2941a3603ffdbf5883c92fc7ef6078e09d7ab1b2b507828b/django-markupfield-helpers-0.1.1.tar.gz" } ] }