Metadata-Version: 1.1
Name: djangocms-slick-slider
Version: 0.9.2
Summary: A Django CMS Slider Plugin with Slick
Home-page: https://github.com/oesah/djangocms_slick_slider
Author: Özer Sahin
Author-email: o.sahin@oesah.de
License: MIT
Description: ==============================
        Django CMS Slick Slider Plugin
        ==============================
        
        .. image:: https://badge.fury.io/py/djangocms-slick-slider.svg
            :target: https://badge.fury.io/py/djangocms-slick-slider
        
        .. image:: https://travis-ci.org/oesah/djangocms-slick-slider.svg?branch=master
            :target: https://travis-ci.org/oesah/djangocms-slick-slider
        
        .. image:: https://codecov.io/gh/oesah/djangocms_slick_slider/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/oesah/djangocms_slick_slider
        
        A Django CMS Slider Plugin with `Slick Slider <http://kenwheeler.github.io/slick/>`_.
        
        Features
        --------
        
        * Add a Slick Slider to any page via Django CMS Plugin
        * Change/set Slick options via ``JSONField``
        * Set some styling options such as color
        
        **CMS**
        
        .. image:: docs/media/admin.png
           :alt: alternate text
           :align: right
        
        
        **Admin Form**
        
        .. image:: docs/media/admin_form.png
           :alt: alternate text
           :align: right
        
        **Output**
        
        .. image:: docs/media/slider.png
           :alt: alternate text
           :align: right
        
        Documentation
        -------------
        
        The full documentation is at https://djangocms-slick-slider.readthedocs.io.
        
        Quickstart
        ----------
        
        Install djangocms_slick_slider::
        
            pip install djangocms-slick-slider
        
        Add it to your `INSTALLED_APPS`:
        
        .. code-block:: python
        
            INSTALLED_APPS = (
                ...
                'djangocms_slick_slider.apps.DjangocmsSlickSliderConfig',
                ...
            )
        
        
        Example project
        ---------------
        
        You can quickly get an example project up to test / develop the plugin.
        
        If you have virtualenvwrapper installed::
        
            git clone https://github.com/oesah/djangocms_slick_slider.git
            cd example
            mkvirtualenv my_project_env
            pip install -r requirements.txt
            python manage.py runserver
        
        Visit your homepage (usually http://localhost:8000).
        
        User: :code:`admin`
        Password: :code:`adminadmin`
        
        You should see some instances of the ``Slick Slider`` plugin. You can play around
        to see, how it works.
        
        
        Settings
        --------
        
        SLICK_SLIDER_VERSION
        ^^^^^^^^^^^^^^^^^^^^
        
        Version of Slick Slider that should be used. Keep in mind, that this version
        needs to be in ``static/vendor/`` folder with the appropriate folder name.
        
        If you want to upgrade, download and copy the new version into the before
        mentioned folder and change the version in the settings.
        
        default: ``1.8.0``
        
        
        SLICK_SLICKER_DEFAULT_OPTIONS
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        ToDo
        
        SLICK_SLIDER_ACE_THEME
        ^^^^^^^^^^^^^^^^^^^^^^
        
        ToDo
        
        SLICK_SLIDER_ACE_MODE
        ^^^^^^^^^^^^^^^^^^^^^
        
        ToDo
        
        Running Tests
        -------------
        
        Does the code actually work?
        
        ::
        
            source <YOURVIRTUALENV>/bin/activate
            (myenv) $ pip install tox
            (myenv) $ tox
        
        If you have issues with different python versions, please take a look at
        these docs: https://www.holger-peters.de/using-pyenv-and-tox.html
        
        
        Release to PyPi
        ---------------
        
        In the project root, run::
        
            bump2version patch|minor|major
            make release
        
        Credits
        -------
        
        Tools used in rendering this package:
        
        *  Cookiecutter_
        *  `cookiecutter-djangopackage`_
        *  `Slick Slider`_
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
        .. _`Slick Slider`: http://kenwheeler.github.io/slick/
        
        
        ToDos
        -----
        
        * make slider respect the order of ``SlickSliderImage`` Plugins
        * add more styling options to plugin
        * translations
        
        
Keywords: djangocms-slick-slider
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django CMS :: 3.4
Classifier: Framework :: Django CMS :: 3.5
Classifier: Framework :: Django CMS :: 3.6
Classifier: Framework :: Django CMS :: 3.7
Classifier: Framework :: Django CMS :: 3.8
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
