Metadata-Version: 1.1
Name: django-uikit-editor
Version: 0.0.1
Summary: uikit_editor provides integration for UiKit htmleditor with Django
Home-page: https://github.com/smidth/django-uikit-editor
Author: Alex Vakhitov
Author-email: alex.vakhitov@gmail.com
License: Simplified BSD
Description: UiKit editor for Django
        =======================
        
        What's that
        -----------
        
        *uikit_editor* is a reusable application for Django, using `UiKit editor <http://getuikit.com/docs/addons_htmleditor.html>`_
        
        
        Dependence
        ----------
        
        - `Django >= 1.3`
        
        Getting started
        ---------------
        
        - Install *uikit_editor*:
        
        ```pip install django-uikit-editor```
        
        - Add `'uikit_editor'` to INSTALLED_APPS.
        
        
        Using in model
        --------------
        
        .. code-block:: python
        
            from django.db import models
            from uikit_editor import UiKitField
        
            class Entry(models.Model):
                title = models.CharField(max_length=250, verbose_name=u'Title')
                text = UiKitField(verbose_name=u'Text')
        
        or use custom parametrs:
        
        .. code-block:: python
        
            text = UiKitField(
                verbose_name=u'Text',
                mode="tab", # 'split', 'tab' default 'split'
                markdown=True #default False
            )
        
        Using for only admin interface
        ------------------------------
        
        .. code-block:: python
        
            from django import forms
            from uikit_editor import UiKitWidget
            from blog.models import Entry
        
            class EntryAdminForm(forms.ModelForm):
                class Meta:
                    model = Entry
                    widgets = {
                       'text': UiKitWidget(),
                    }
        
            class EntryAdmin(admin.ModelAdmin):
                form = EntryAdminForm
        
        `UiKitWidget` takes the same parameters as `UiKitField`.
        
        
        
        Contributing
        ------------
        
        1. Fork it!
        2. Create your feature branch: `git checkout -b my-new-feature`
        3. Commit your changes: `git commit -am 'Add some feature'`
        4. Push to the branch: `git push origin my-new-feature`
        5. Submit a pull request =]
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Framework :: Django
