Metadata-Version: 2.1
Name: django-scribbler
Version: 1.2.0
Summary: django-scribbler is an application for managing snippets of text for a Django website.
Home-page: https://github.com/caktus/django-scribbler
Author: Caktus Consulting Group
Author-email: solutions@caktusgroup.com
License: BSD-2-Clause
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
License-File: LICENSE
License-File: AUTHORS

django-scribbler
===================

django-scribbler is an application for managing snippets of text for a Django website.
Similar projects include django-flatblocks, django-chunks and django-pagelets. This
project attempts to take some of the best concepts from those previous projects as
well as focus on giving the users instant feedback inspired by Bret Victor's
`Inventing on Principle <http://vimeo.com/36579366>`_ talk.

.. image:: https://travis-ci.org/caktus/django-scribbler.svg?branch=master
    :alt: Build Status
    :target: https://travis-ci.org/caktus/django-scribbler


Features
--------------------------------------

- Simple template tag for defining snippet blocks with default text
- Template tag for displaying and editing fields from arbitrary models
- Front-end editing of snippets with the powerful `CodeMirror <http://codemirror.net/>`_ editor
- Live in-place preview of content while editing
- The full power of the Django template language in the snippet blocks
- Python 3 support


Installation
--------------------------------------

django-scribbler currently requires Django 2.2, 3.2, or 4.0 and Python >= 3.7. Older versions of
django-scribbler may support older versions of Django and Python.

To install from PyPi::

    pip install django-scribbler

.. note:: If you need to run an unreleased version from the repository, see the `Contributing Guide <http://django-scribbler.readthedocs.org/en/latest/contributing.html>`_ for additional instructions.

Documentation
-----------------------------------

Documentation on using django-scribbler is available on
`Read The Docs <http://readthedocs.org/docs/django-scribbler/>`_.


License
--------------------------------------

django-scribbler is released under the BSD License. See the
`LICENSE <https://github.com/caktus/django-scribbler/blob/master/LICENSE>`_ file for more details.


Contributing
--------------------------------------

If you think you've found a bug or are interested in contributing to this project
check out `django-scribbler on Github <https://github.com/caktus/django-scribbler>`_. A
full contributing guide can be found in the `online documentation <http://django-scribbler.readthedocs.org/en/latest/contributing.html>`_.

If you are interested in translating django-scribbler into your native language
you can join the `Transifex project <https://www.transifex.com/projects/p/django-scribbler/>`_.

Development sponsored by `Caktus Consulting Group, LLC
<http://www.caktusgroup.com/services>`_.
