Skip to main content

A generic Django application to convert text with specific markup to html.

Project description

https://img.shields.io/pypi/v/django-markup.svg https://travis-ci.org/bartTC/django-markup.svg?branch=master https://api.codacy.com/project/badge/Coverage/59e4d38171644acaa13731f08f83ec10 https://api.codacy.com/project/badge/Grade/59e4d38171644acaa13731f08f83ec10

📖 Full documentation on https://django-markup.readthedocs.io/en/latest/

django-markup

This app is a generic way to provide filters that convert text into html.

Quickstart

Download and install the package from the python package index (pypi):

$ pip install django-markup

Note that django-markup ships with some filters ready to use, but the more complex packages such as Markdown or ReStructuredText are not part of the code. Please refer the docs which packages are used for the built-in filter.

An alternative is to install django-markup with all filter dependencies right away. Do so with:

$ pip install django-markup[all_filter_dependencies]

Then add it to the INSTALLED_APPS list:

INSTALLED_APPS = (
    ...
    'django_markup',
)

Use it in the template:

{% load markup_tags %}
{{ the_text|apply_markup:"markdown" }}

Or in Python code:

from django_markup.markup import formatter
formatter('Some *Markdown* text.', filter_name='markdown')

Testsuite

To run the testsuite install the project with pipenv and run it:

% pipenv install --dev
$ pipenv run test

You can also test against a variation of Django and Python versions using tox:

$ tox

Changelog

v1.5 (2020-06-12):

  • Dropped support for Django <=1.11 and Python <=3.5.

  • Python 3.8 compatibility and tests.

  • Django 3.0 compatibility and tests.

  • bleach-whitelist dependency is no longer necessary as tags are now shipped with the built-in markdown filter.

  • Uses pytest for testing.

v1.4 (2019-03-15):

  • Markdown’s safe_mode was deprecated and no longer functional, it’s behavior was replaced with bleach.

  • Pipfile support for local development and general code cleanup.

v1.3 (2018-09-07):

  • Python 3.6 and 3.7 compatibility and tests.

  • Django 2.0 and 2.1 compatibility and tests.

  • The package setup script now provides the ability to install all filter dependencies automatically. See the installation Readme for details.

v1.2 (2017-03-18):

  • Django 1.10 compatibility and tests.

  • Updated all filter dependencies. most notably SmartyPants to v2.0 which changed it’s API, so your project dependencies need to update it as well.

v1.1 (2016-05-02):

  • The Markdown filter has the safe_mode option enabled by default.

  • The RestructuredText filter has the file and raw content inclusion disabled by default.

v1.0 (2016-01-02):

  • Removed some 5 year old dust

  • Django 1.8+ compatible

  • Tests

Backwards incompatible changes:

  • Removed Pygments highlighting in the Markdown and RestructuredText filter.

  • Removed CreoleParser library in favor of a pypi package.

  • Removed Lightbox filter.

  • The RestructuredText filter now renders level 1 and 2 headers. See Github Issue 14 for details and a backwards compatible workaround.

v0.4 (2011-06-01):

  • Added a widont filter

  • MarkupField is South compatible.

  • Tested with Django 1.3

v0.3 (2009-07-29):

django-markup now ships with a builtin creole parser. Advantage is, that the recently used Creoleparser library needs the Genshi lib, which needs a c-compiler and so on. The builtin creole parser is a pure python library without any dependencies and follows the wikicreole.org specifications. django-markup uses the WikiCreole library.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-markup-1.5.tar.gz (30.4 kB view details)

Uploaded Source

Built Distribution

django_markup-1.5-py2.py3-none-any.whl (17.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-markup-1.5.tar.gz.

File metadata

  • Download URL: django-markup-1.5.tar.gz
  • Upload date:
  • Size: 30.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.8.0

File hashes

Hashes for django-markup-1.5.tar.gz
Algorithm Hash digest
SHA256 e7b6eb670f644bccd62157d18e89fb7a35df02605d5edb30a8578dc6ffbd684b
MD5 040eb27da9a68d009f028e1725e5b83d
BLAKE2b-256 8ea8be7676854e50291ac8c727a9b1f46c16fba6521221f5a2a1cac2ffbc9f51

See more details on using hashes here.

File details

Details for the file django_markup-1.5-py2.py3-none-any.whl.

File metadata

  • Download URL: django_markup-1.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 17.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.8.0

File hashes

Hashes for django_markup-1.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9d22dd08681ffc20235ffb81eb58d97568d86a3b0dc4517f142f74577484674c
MD5 d91ee8ec271e005d89d15a7db61b6c6f
BLAKE2b-256 d626481f516e8d9853ba5fe7ffd3bcd0dd459b40bf3aa902171f2463467e953e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page