A reusable Django app adding filer-based galleries to Django-CMS.
Project description
CMSplugin Image Gallery
====================
A Django application adding filer-based galleries to Django-CMS.
Installation
------------
You need to install the following prerequisites in order to use this app::
pip install Django
pip install django-cms
pip install django-filer
pip install Pillow
If you want to install the latest stable release from PyPi::
$ pip install cmsplugin-image-gallery
If you feel adventurous and want to install the latest commit from GitHub::
$ pip install -e git://github.com/bitmazk/cmsplugin-image-gallery.git#egg=image_gallery
Add ``image_gallery`` to your ``INSTALLED_APPS``::
INSTALLED_APPS = (
...,
'image_gallery',
)
Usage
-----
First create a gallery object with a filer folder.
Using the apphook
+++++++++++++++++
Simply create a django-cms page and select it in the ``Application`` field of
the ``Advanced Settings``.
Using the cmsplugin
+++++++++++++++++++
Create a CMS page with a placeholder and simply insert the plugin
``Filer Gallery``.
Using the template tags
+++++++++++++++++++++++
You can also use our template tag to display a list of pictures::
{% render_pictures %}
...for the last 3 uploaded pictures. You can use the selection parameters
``recent`` (default) and ``random`` and set an amount of pictures to display::
{% render_pictures 'random' 10 %}
Settings
--------
GALLERY_PAGINATION_AMOUNT
+++++++++++++++++++++++++
Default: 10
Amount of galleries to display in the list view.
Contribute
----------
If you want to contribute to this project, please perform the following steps::
# Fork this repository
# Clone your fork
$ mkvirtualenv -p python2.7 cmsplugin-image-gallery
$ pip install -r requirements.txt
$ ./logger/tests/runtests.sh
# You should get no failing tests
$ git co -b feature_branch master
# Implement your feature and tests
# Describe your change in the CHANGELOG.txt
$ git add . && git commit
$ git push origin feature_branch
# Send us a pull request for your feature branch
Whenever you run the tests a coverage output will be generated in
``tests/coverage/index.html``. When adding new features, please make sure that
you keep the coverage at 100%.
Roadmap
-------
Check the issue tracker on github for milestones and features to come.
====================
A Django application adding filer-based galleries to Django-CMS.
Installation
------------
You need to install the following prerequisites in order to use this app::
pip install Django
pip install django-cms
pip install django-filer
pip install Pillow
If you want to install the latest stable release from PyPi::
$ pip install cmsplugin-image-gallery
If you feel adventurous and want to install the latest commit from GitHub::
$ pip install -e git://github.com/bitmazk/cmsplugin-image-gallery.git#egg=image_gallery
Add ``image_gallery`` to your ``INSTALLED_APPS``::
INSTALLED_APPS = (
...,
'image_gallery',
)
Usage
-----
First create a gallery object with a filer folder.
Using the apphook
+++++++++++++++++
Simply create a django-cms page and select it in the ``Application`` field of
the ``Advanced Settings``.
Using the cmsplugin
+++++++++++++++++++
Create a CMS page with a placeholder and simply insert the plugin
``Filer Gallery``.
Using the template tags
+++++++++++++++++++++++
You can also use our template tag to display a list of pictures::
{% render_pictures %}
...for the last 3 uploaded pictures. You can use the selection parameters
``recent`` (default) and ``random`` and set an amount of pictures to display::
{% render_pictures 'random' 10 %}
Settings
--------
GALLERY_PAGINATION_AMOUNT
+++++++++++++++++++++++++
Default: 10
Amount of galleries to display in the list view.
Contribute
----------
If you want to contribute to this project, please perform the following steps::
# Fork this repository
# Clone your fork
$ mkvirtualenv -p python2.7 cmsplugin-image-gallery
$ pip install -r requirements.txt
$ ./logger/tests/runtests.sh
# You should get no failing tests
$ git co -b feature_branch master
# Implement your feature and tests
# Describe your change in the CHANGELOG.txt
$ git add . && git commit
$ git push origin feature_branch
# Send us a pull request for your feature branch
Whenever you run the tests a coverage output will be generated in
``tests/coverage/index.html``. When adding new features, please make sure that
you keep the coverage at 100%.
Roadmap
-------
Check the issue tracker on github for milestones and features to come.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cmsplugin-image-gallery-0.2.tar.gz
(428.4 kB
view hashes)
Close
Hashes for cmsplugin-image-gallery-0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 977af9194164cf7bfd383c87e12df0fe25a9e426c733e015c6c9934d11d6a8bd |
|
MD5 | 1696436280b27503aba13ba142718551 |
|
BLAKE2b-256 | fe855d9899a70a9eef295720e39949dbff6b75426351d5dd00fd94311f5486e1 |