Metadata-Version: 2.0
Name: awesto-djangocms-carousel
Version: 0.2.2
Summary: A carousel plugin for djangoCMS
Home-page: https://github.com/awesto/djangocms-carousel
Author: René Fleschenberg
Author-email: rene@fleschenberg.net
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities
Requires-Dist: Django (<1.10,>=1.8.5)
Requires-Dist: django-admin-sortable (<=2.0.18)
Requires-Dist: django-cms (>=3.3.3)
Requires-Dist: django-filer (>=1.2.6)

========
Overview
========



A carousel plugin for djangoCMS

* Free software: MIT license

This plugin was originally forked from
https://github.com/MagicSolutions/cmsplugin-carousel, but most of the
functionality has been replaced. This version is not compatible with the plugin
from Magic Solutions.

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

::

    pip install awesto-djangocms-carousel


Add ``cmsplugin_carousel`` to your ``INSTALLED_APPS``.

Usage
=====

Add a `Carousel` plugin to one of your placeholders. You can then add abritrary
child plugins which will be displayed as carousel items.

A `Carousel Caption` plugin is also provided.

A common scenario is:

- Carousel

  - Link

    - Image

    - Caption

        - Text

Documentation
=============

https://djangocms-carousel.readthedocs.io/

Development
===========

To run the all tests run::

    tox

Note, to combine the coverage data from all the tox environments run:

.. list-table::
    :widths: 10 90
    :stub-columns: 1

    - - Windows
      - ::

            set PYTEST_ADDOPTS=--cov-append
            tox

    - - Other
      - ::

            PYTEST_ADDOPTS=--cov-append tox


Changelog
=========

0.1.0 (2017-02-22)
-----------------------------------------

* First release on PyPI.


