Merge pull request #324 from nephila/feature/optional_search

Remove strict dependency on aldryn-search for leaner installs

HISTORY.rst

@@ -18,6 +18,7 @@ History
 * Enabled cached version of BlogLatestEntriesPlugin.
 * Added plugins templateset.
 * Improved category admin to avoid circular relationships.
+* Dropped strict dependency on aldyn-search, haystack. Install separately for search support.
 
 ******************
 0.8.8 (2016-09-04)

README.rst

@@ -41,6 +41,10 @@ Supported django CMS versions:
 
 * django CMS 3.2+
 
+.. warning:: Strict dependency on aldryn-search, haystack has been dropped. Install
+             them separately to enable full text search support. See `installation docs`_
+             for details.
+
 .. warning:: Version 0.8 will be the last one supporting Python 2.6, Python 3.3,
              Django<1.8 and django CMS<3.2.
 
@@ -49,13 +53,6 @@ Supported django CMS versions:
              This does not change the overall behavior, but be warned if you
              expect it to be not null in custom code.
 
-.. warning:: Version 0.6 changes the field of LatestPostsPlugin.tags field.
-             A datamigration is in place to migrate the data, but check that
-             works ok for your project before upgrading, as this might delete
-             some relevant data.
-             Some plugins have a broken tag management prior to 0.6, in case
-             you have issues with tags, upgrade to latest version to have it fixed.
-
 *****************************************
 Upgrading cmsplugin-filer from 1.0 to 1.1
 *****************************************
@@ -119,3 +116,6 @@ Known djangocms-blog websites
 *****************************
 
 See DjangoPackages for an updated list https://www.djangopackages.com/packages/p/djangocms-blog/
+
+
+.. _installation docs: http://djangocms-blog.readthedocs.io/en/latest/installation.html

docs/installation.rst

@@ -29,6 +29,16 @@ Then migrate::
 
     $ python manage.py migrate
 
+If you want to enable haystack support, in addition to the above:
+
+* install djangocms-blog with::
+
+    pip install djangocms-blog[search]
+
+* add ``aldryn_search`` to ``INSTALLED_APPS``
+* configure haystack according to `aldryn-search docs <https://github.com/aldryn/aldryn-search#usage>`_
+  and `haystack docs <http://django-haystack.readthedocs.io/en/stable/>`_.
+
 *********************
 Minimal configuration
 *********************
@@ -77,7 +87,7 @@ suited for your deployment.
   * Publish the page
   * Restart the project instance to properly load blog urls.
 
-.. warning:: After adding the apphook to the page you **cannot** change the **Instance Namspace**
+.. warning:: After adding the apphook to the page you **cannot** change the **Instance Namespace**
              field for the defined **AppHokConfig**; if you want to change it, create a new one
              with the correct namespace, go in the CMS page **Advanced settings** and switch to the
              new **Application configuration**
@@ -107,7 +117,8 @@ Please, refer to each application documentation on details.
 * django-meta-mixin: https://github.com/nephila/django-meta-mixin#installation
 * django-parler: https://django-parler.readthedocs.io/en/latest/quickstart.html#configuration
 * django-taggit-autosuggest: https://bitbucket.org/fabian/django-taggit-autosuggest
-
+* aldryn-search: https://github.com/aldryn/aldryn-search#usage>
+* haystack: http://django-haystack.readthedocs.io/en/stable/
 
 .. _auto_setup:
 

requirements-test.txt

@@ -10,3 +10,4 @@ tox>=2.0
 wheel
 pysolr
 django-parler>=1.6
+aldryn-search

setup.py

@@ -40,8 +40,10 @@ setup(
         'django-meta-mixin>=0.3',
         'aldryn-apphooks-config>=0.2.6',
         'djangocms-apphook-setup',
-        'aldryn-search'
     ],
+    extras_require={
+        'search': ['aldryn-search']
+    },
     license='BSD',
     zip_safe=False,
     keywords='djangocms-blog, blog, django, wordpress, multilingual',