<commit_before>===============
django-markitup
===============

A Django reusable application for end-to-end markup handling. Includes:

* Easy integration of the `MarkItUp!`_ markup editor widget (by Jay
  Salvat) in Django projects, with server-side support for MarkItUp!'s
  AJAX preview. Plug in MarkItUp! via form widget or template tags.

* ``MarkupField``, a ``TextField`` that automatically renders and
  stores both its raw and rendered values in the database, on the
  assumption that disk space is cheaper than CPU cycles in a web
  application.

.. _MarkItUp!: http://markitup.jaysalvat.com/


Installation
============

Install from PyPI with ``easy_install`` or ``pip``::

    pip install django-markitup

or get the `in-development version`_::

    pip install django-markitup==tip

.. _in-development version: http://bitbucket.org/carljm/django-markitup/get/tip.gz#egg=django_markitup-tip

To use ``django-markitup`` in your Django project:

    1. Add ``'markitup'`` to your ``INSTALLED_APPS`` setting.

    2. Make the contents of the ``markitup/static/markitup`` directory
       available at ``STATIC_URL/markitup``; the simplest way is via
       `django.contrib.staticfiles`_.

    3. Set `the MARKITUP_FILTER setting`_.

    4. If you want to use AJAX-based preview, add
          ``url(r'^markitup/', include('markitup.urls'))`` in your root URLconf.

.. _django.contrib.staticfiles: https://docs.djangoproject.com/en/dev/howto/static-files/


Dependencies
------------

``django-markitup`` 2.x requires `Django`_ 1.4 or later and Python 2.6 or later.

``django-markitup`` 1.x requires `Django`_ 1.3 or later and Python 2.5 or later.

`MarkItUp!`_ is not an external dependency; it is bundled with
``django-markitup``.

.. _Django: http://www.djangoproject.com/

Using the MarkItUp! widget<commit_msg>Update Python dependency version in README.<commit_after>===============
django-markitup
===============

A Django reusable application for end-to-end markup handling. Includes:

* Easy integration of the `MarkItUp!`_ markup editor widget (by Jay
  Salvat) in Django projects, with server-side support for MarkItUp!'s
  AJAX preview. Plug in MarkItUp! via form widget or template tags.

* ``MarkupField``, a ``TextField`` that automatically renders and
  stores both its raw and rendered values in the database, on the
  assumption that disk space is cheaper than CPU cycles in a web
  application.

.. _MarkItUp!: http://markitup.jaysalvat.com/


Installation
============

Install from PyPI with ``easy_install`` or ``pip``::

    pip install django-markitup

or get the `in-development version`_::

    pip install django-markitup==tip

.. _in-development version: http://bitbucket.org/carljm/django-markitup/get/tip.gz#egg=django_markitup-tip

To use ``django-markitup`` in your Django project:

    1. Add ``'markitup'`` to your ``INSTALLED_APPS`` setting.

    2. Make the contents of the ``markitup/static/markitup`` directory
       available at ``STATIC_URL/markitup``; the simplest way is via
       `django.contrib.staticfiles`_.

    3. Set `the MARKITUP_FILTER setting`_.

    4. If you want to use AJAX-based preview, add
          ``url(r'^markitup/', include('markitup.urls'))`` in your root URLconf.

.. _django.contrib.staticfiles: https://docs.djangoproject.com/en/dev/howto/static-files/


Dependencies
------------

``django-markitup`` 2.x requires `Django`_ 1.4 or later and Python 2.6+ or 3.3+.

``django-markitup`` 1.x requires `Django`_ 1.3 or later and Python 2.5 or later.

`MarkItUp!`_ is not an external dependency; it is bundled with
``django-markitup``.

.. _Django: http://www.djangoproject.com/

Using the MarkItUp! widget
{'fraction_non_alphanumeric': 0.1375, 'fraction_numerical': 0.008152173913043478, 'mean_word_length': 3.8562005277044853, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4059232', 'n_tokens_mistral': 1234, 'n_tokens_neox': 1149, 'n_words': 388}