Metadata-Version: 1.1
Name: djangocms-picture
Version: 2.0.2
Summary: Adds an image plugin to django CMS
Home-page: https://github.com/divio/djangocms-picture
Author: Divio AG
Author-email: info@divio.ch
License: BSD
Description: ==================
        django CMS Picture
        ==================
        
        
        |pypi| |build| |coverage|
        
        **django CMS Picture** is a plugin for `django CMS <http://django-cms.org>`_
        that allows you to add images on your site.
        
        This addon is compatible with `Aldryn <http://aldryn.com>`_ and is also available on the
        `django CMS Marketplace <https://marketplace.django-cms.org/en/addons/browse/djangocms-picture/>`_
        for easy installation.
        
        .. image:: preview.gif
        
        
        Contributing
        ============
        
        This is a an open-source project. We'll be delighted to receive your
        feedback in the form of issues and pull requests. Before submitting your
        pull request, please review our `contribution guidelines
        <http://docs.django-cms.org/en/latest/contributing/index.html>`_.
        
        One of the easiest contributions you can make is helping to translate this addon on
        `Transifex <https://www.transifex.com/projects/p/djangocms-picture/>`_.
        
        
        Documentation
        =============
        
        See ``REQUIREMENTS`` in the `setup.py <https://github.com/divio/djangocms-picture/blob/master/setup.py>`_
        file for additional dependencies:
        
        * Python 2.7, 3.3 or higher
        * Django 1.8 or higher
        
        Make sure `django Filer <http://django-filer.readthedocs.io/en/latest/installation.html>`_
        is installed and configured appropriately.
        
        
        Installation
        ------------
        
        For a manual install:
        
        * run ``pip install djangocms-picture``
        * add ``djangocms_picture`` to your ``INSTALLED_APPS``
        * run ``python manage.py migrate djangocms_picture``
        
        
        Configuration
        -------------
        
        Note that the provided templates are very minimal by design. You are encouraged
        to adapt and override them to your project's requirements.
        
        This addon provides a ``default`` template for all instances. You can provide
        additional template choices by adding a ``DJANGOCMS_PICTURE_TEMPLATES``
        setting::
        
            DJANGOCMS_PICTURE_TEMPLATES = [
                ('background', _('Background image')),
            ]
        
        You'll need to create the `feature` folder inside ``templates/djangocms_picture/``
        otherwise you will get a *template does not exist* error. You can do this by
        copying the ``default`` folder inside that directory and renaming it to
        ``background``.
        
        Another setting is ``DJANGOCMS_PICTURE_NESTING``, which allows you to render an image
        as the background image of a container that also contains other content (text, icons
        and so on).
        ::
        
            DJANGOCMS_PICTURE_NESTING = True
        
        will enable this (the default is ``False``). When set to ``True``, you'll be able to place additional
        plugins inside the picture plugin.
        
        You can override alignment styles with ``DJANGOCMS_PICTURE_ALIGN``, for example::
        
            DJANGOCMS_PICTURE_ALIGN = [
                ('top', _('Top Aligned')),
            ]
        
        This will generate a class prefixed with ``align-``. The example above
        would produce a ``class="align-top"``. Adding a ``class`` key to the image
        attributes automatically merges the alignment with the attribute class.
        
        You can use ``DJANGOCMS_PICTURE_RATIO`` to set the width/height ratio of images
        if these values are not set explicitly on the image::
        
            DJANGOCMS_PICTURE_RATIO = 1.618
        
        We use the `golden ratio <https://en.wikipedia.org/wiki/golden_ratio>`_,
        approximately 1.618, as a default value for this.
        
        When working out sizes for the image, the system will use the following values,
        of preference:
        
        * the width or height set in the *Thumbnail options*
        * *Autoscale*
        * the *Width* and *Height*
        
        We recommend setting width or height values around a placeholder so
        when the plugin uses *Autoscale* it can discover them::
        
            {% with 720 as width and 480 as height %}
                {% placeholder content %}
            {% endwith %}
        
        Further configuration can be achieved through
        `django Filer <https://django-filer.readthedocs.io/en/latest/settings.html>`_.
        
        
        Running Tests
        -------------
        
        You can run tests by executing::
        
            virtualenv env
            source env/bin/activate
            pip install -r tests/requirements.txt
            python setup.py test
        
        
        .. |pypi| image:: https://badge.fury.io/py/djangocms-picture.svg
            :target: http://badge.fury.io/py/djangocms-picture
        .. |build| image:: https://travis-ci.org/divio/djangocms-picture.svg?branch=master
            :target: https://travis-ci.org/divio/djangocms-picture
        .. |coverage| image:: https://codecov.io/gh/divio/djangocms-picture/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/divio/djangocms-picture
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
