djangocms-installer 0.7.8

Command to easily bootstrap django CMS projects

====================
django CMS Installer
====================


.. image:: https://img.shields.io/pypi/v/djangocms-installer.svg
:target: https://pypi.python.org/pypi/djangocms-installer
:alt: Latest PyPI version

.. image:: https://img.shields.io/travis/nephila/djangocms-installer.svg
:target: https://travis-ci.org/nephila/djangocms-installer
:alt: Latest Travis CI build status

.. image:: https://img.shields.io/pypi/dm/djangocms-installer.svg
:target: https://pypi.python.org/pypi/djangocms-installer
:alt: Monthly downloads

.. image:: https://coveralls.io/repos/nephila/djangocms-installer/badge.png
:target: https://coveralls.io/r/nephila/djangocms-installer
:alt: Test coverage

Command to easily bootstrap django CMS projects

* Free software: BSD license

Features
--------

``djangocms-installer`` is a console wizard to help bootstrapping a django CMS
project.

Refer to `django CMS Tutorial <http://django-cms.readthedocs.org/en/latest/introduction/index.html>`_
on how to properly setup your first django CMS project.

.. note:: It used to be called **aldryn-installer**, but since version 0.2.0
it's been renamed **djangocms-installer** for clarity.

Installation
------------

#. Create an empty virtualenv::

virtualenv /virtualenv/path/my_project

#. Install `djangocms-installer`::

pip install djangocms-installer

or::

pip install -e git+https://github.com/nephila/djangocms-installer#egg=djangocms-installer

Documentation
-------------

See http://djangocms-installer.readthedocs.org

Supported versions
------------------

The current supported version matrix is the following:

+----------------+-------------+-------------+-------------+-------------+-------------+
| | Django 1.4 | Django 1.5 | Django 1.6 | Django 1.7 | Django 1.8 |
+----------------+-------------+-------------+-------------+-------------+-------------+
| django CMS 2.4 | Supported | Supported | Unsupported | Unsupported | Unsupported |
+----------------+-------------+-------------+-------------+-------------+-------------+
| django CMS 3.0 | Supported | Supported | Supported | Supported | Unsupported |
+----------------+-------------+-------------+-------------+-------------+-------------+
| django CMS 3.1 | Unsupported | Unsupported | Supported | Supported | Supported |
+----------------+-------------+-------------+-------------+-------------+-------------+
| django CMS dev | Unsupported | Unsupported | Supported | Supported | Supported |
+----------------+-------------+-------------+-------------+-------------+-------------+

Any beta and develop version of Django and django CMS, by its very nature,
it's not supported, while it still may work.

``djangocms-installer`` tries to support beta versions of django CMS when they
will be considered sufficiently stable by the upstream project.

Warning
-------

``djangocms-installer`` assumes that ``django-admin.py`` is installed in the same directory
as python executable, which is the standard virtualenv layout.

Caveats
-------

While this wizard try to handle most of the things for you, it doesn't check for
all the proper native (non python) libraries to be installed.
Before running this, please check you have the proper header and libraries
installed and available for packages to be installed.

Libraries you would want to check:

* libjpeg (for JPEG support in ``Pillow``)
* zlib (for PNG support in ``Pillow``)
* postgresql (for ``psycopg``)
* libmysqlclient (for ``Mysql-Python``)
* python-dev (for compilation and linking)

For additional information, check http://djangocms-installer.readthedocs.org/en/latest/libraries.html


Windows support
---------------

The installer is tested on Windows 7 with Python versions 3.4.2 and 2.7.8 installed using
official MSI packages available at http://python.org.

Please check that the ``.py`` extension is associated correctly with Python interpreter::

c:\> assoc .py
.py=Python.File

c:\>ftype Python.File
Python.File="C:\Windows\py.exe" "%1" %*





History
-------

0.7.8 (2015-06-27)
++++++++++++++++++

* Add Django 1.8 support
* Fix template styles

0.7.7 (2015-06-05)
++++++++++++++++++

* Switch to cloudflare CDN for bootstrap template
* Fix support for django-filer 0.9.10

0.7.6 (2015-05-01)
++++++++++++++++++

* Switch to django CMS 3.1 as stable django CMS release
* Rework the Django supported matrix
* Always use djangocms-link instead of cmsplugin-filer-link

0.7.5 (2015-04-21)
++++++++++++++++++

* Add support for django CMS 3.1
* Switch to Django 1.7 as stable django release

0.7.4 (2015-04-14)
++++++++++++++++++

* Add automatic timezone detection
* Pin django-reversion versions
* Make installer more compatible with windows environment

0.7.3 (2015-04-08)
++++++++++++++++++

* Fix issues with django CMS requirements
* Fix minor issues in shipped templates

0.7.2 (2015-02-08)
++++++++++++++++++

* Fixed Windows compatibility issues
* Fixed python 3 compatibility issues
* Add a flag to skip the project directory emptiness check

0.7.1 (2015-01-15)
++++++++++++++++++

* Ask for permission before cleanup
* Clarify the `-p` parameter
* Check if the project directory is empty before proceeding

0.7.0 (2015-01-10)
++++++++++++++++++

* Improved support for Django 1.7 and django CMS develop (3.1)
* Totally new test strategy
* Reverted -I parameter to install packages
* Improved support for cleanup after failure

0.6.0 (2014-11-30)
++++++++++++++++++

* Add support for installing aldryn-boilerplate
* Force installing all packages (-I) when creating the project virtualenv
* Fix multiplatform support bugs
* Update supported Django / django CMS versions
* Add preliminary support for django CMS develop (3.1)

0.5.4 (2014-08-14)
++++++++++++++++++

* Fix reversion version selection for older Django versions
* Better project name validation

0.5.3 (2014-07-23)
++++++++++++++++++

* Add support for easy_thumbnails 2.0 migrations
* Fix asking for creating user even when --no-input flag is used
* Unpin reversion as django CMS 3.0.3 solves the issue
* Versioned dependency for django-filer when installing django CMS 2.4
* Switch to official django-filer and cmsplugin-filer releases for CMS 3.0

0.5.2 (2014-05-30)
++++++++++++++++++

* Pin reversion to 1.8 waiting for a proper fix in django CMS

0.5.1 (2014-05-22)
++++++++++++++++++

* Fix error in bootstrap template handling
* Add clarification about custom template set and starting page

0.5.0 (2014-05-21)
++++++++++++++++++

* Add dump-requirements argument
* Add user provided extra setting
* Add FAQ section
* Add templates argument
* Documentation update

0.4.2 (2014-04-26)
++++++++++++++++++

* Use current cms.context_processors.cms_settings instead of deprecated one
* Document some fixes for library issues
* Fix Python 3 issue
* Switch default Django version to stable instead of 1.5

0.4.1 (2014-04-09)
++++++++++++++++++

* Fix some newlines issues in the settings file

0.4.0 (2014-04-09)
++++++++++++++++++

* Update for django CMS 3.0 stable!
* Fixes for settings parameter

0.3.5 (2014-04-03)
++++++++++++++++++

* Update for django CMS 3.0c2

0.3.4 (2014-03-29)
++++++++++++++++++

* Fix issues with django CMS 2.4

0.3.3 (2014-03-20)
++++++++++++++++++

* Better handling of differenct CMS version configuration

0.3.2 (2014-03-18)
++++++++++++++++++

* Fix some versioned dependency resolve error

0.3.1 (2014-03-16)
++++++++++++++++++

* Fix error in loading resource files
* Fix error with non-standard python executable paths
* Fix error with Django 1.6
* Fix error installing django-filer

0.3.0 (2014-03-15)
++++++++++++++++++

* Sync with django CMS RC1 changes
* Use external django CMS plugins instead of removed core ones

0.2.0 (2014-02-06)
++++++++++++++++++

* Project renamed to djangocms-installer
* Bugfixes
* Better default templates
* Python 3 compatibility
* Django 1.6 compatibility
* django CMS 3 beta3 and dev snapshot support
* Support for django-admin project templates
* Ships Twitter bootstrap templates
* Can now creates a dummy starting page

0.1.1 (2013-10-20)
++++++++++++++++++

* Improved documentation on how to fix installation in case of missing libraries.

0.1.0 (2013-10-19)
++++++++++++++++++

* First public release.