skip to navigation
skip to content

djangocms-picture 2.0.2

Adds an image plugin to django CMS

django CMS Picture

|pypi| |build| |coverage|

**django CMS Picture** is a plugin for `django CMS <http:"">`_
that allows you to add images on your site.

This addon is compatible with `Aldryn <http:"">`_ and is also available on the
`django CMS Marketplace <https:"" en="" addons="" browse="" djangocms-picture=""/>`_
for easy installation.

.. image:: preview.gif


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:"" en="" latest="" contributing="" index.html="">`_.

One of the easiest contributions you can make is helping to translate this addon on
`Transifex <https:"" projects="" p="" djangocms-picture=""/>`_.


See ``REQUIREMENTS`` in the ` <https:"" divio="" djangocms-picture="" blob="" master="""">`_
file for additional dependencies:

* Python 2.7, 3.3 or higher
* Django 1.8 or higher

Make sure `django Filer <http:"" en="" latest="" installation.html="">`_
is installed and configured appropriately.


For a manual install:

* run ``pip install djangocms-picture``
* add ``djangocms_picture`` to your ``INSTALLED_APPS``
* run ``python migrate djangocms_picture``


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``

('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

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).


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::

('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::


We use the `golden ratio <https:"" 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:"" 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 test

.. |pypi| image::
.. |build| image::
.. |coverage| image::
File Type Py Version Uploaded on Size
djangocms-picture-2.0.2.tar.gz (md5) Source 2016-09-20 23KB