Metadata-Version: 1.1
Name: django-inlineedit
Version: 1.0
Summary: Add inline editble fields to your templates
Home-page: https://github.com/ptav/django-inlineedit
Author: Pedro Tavares
Author-email: web@ptavares.com
License: LICENSE
Description: # django-inlineedit
        
        Inline editing for Django models
        
        
        ## Installation
        
        1. Use pip to install the latest stable release
            
            `pip install django-inlineedit`
           
           OR
           
           Run the following command inside the top-level cloned repository:
           
           'easy_install .'
        2. Add `inlineedit` to `INSTALLED_APPS` in the project settings (see dependencies below)
        
        3. Add `path(<url for form submission>, include('inlineedit.urls'))` to the base URLs
        
            django-inlineedit will use any URL you specify, make sure it does not conflict with
            existing URLs in your app!
        
        
        ## Quickstart
        
        In your templates add the django-inlineedit JS in a suitable location (for example at the bottom of the template `<body>`):
            {% load inlineedit_default_script %}
            {% inlineedit_default_script %}
        
        Then load the template tags with:
        
            {% load inlineedit %}
        
        to add inline editing to a field, you use the `inlineedit` template tag. For example:
        
            {% inlineedit "my_object.my_field" %}
        
        This will add the HTML and JS necessary to edit `my_field` in object `my_object`. without any further configuration, the tag will display the field and show the editing link when the mouse hover over the field. A single click will open up an editing element and accept/reject buttons. Click the former to accept any changes and the latter to cancel those.
        
        ## Dependencies:
        
        Required jquery 3.3.1 or higher installed.
        
        
        ### Support for integration with other libraries (optional)
        
        1. django-reversions
            
            No configuration is needed, django-inlineedit will simply use django-reversion as long 
            as your models are decorated with @reversion.register()
        
        2. Django-CKEditor
        
            Version 5.9.0 or higher is required for the CKEditor adaptor to work. for example:
        
                {% inlineedit "my_object.my_field" "ckeditor" %}
        
            Or
        
                {% inlineedit "my_object.my_field" "ckeditor" "toolbar" %}
        
        
        2. Markdown
        
            The Python library Markdown is required for the adaptor to work
        
                {% inlineedit "my_object.my_field" "markdown" %}
        
        
        ## Running examples
        
        1. cd into the root directory of the example you want to run (under the examples folder)
        2. run `python3 manage.py migrate` to setup a local sqlite3 database.
        3. run `python3 manage.py runserver` to start a local development server for the example.
        
        
        ## Open source licenses
        
        This product depends on the following software and media packages
        
        Bootstrap version 4.0 is licensed under the [MIT License](http://opensource.org/licenses/mit-license.html)
        
Keywords: django,forms,editing
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Framework :: Django
Classifier: Environment :: Web Environment
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
