global: release checklist

* FIX Adds changes according to release preparation checklist.

* FIX Pins elasticsearch-dsl to less than 5.1.0 due to change
  in Response class constructor signature. (addresses inveniosoftware#96)

Signed-off-by: Paulina Lach <[email protected]>
Co-authored-by: Diego Rodriguez <[email protected]>

Author: 2 people

.editorconfig

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # This file is part of Invenio.
-# Copyright (C) 2015, 2016 CERN.
+# Copyright (C) 2015, 2016, 2017 CERN.
 #
 # Invenio is free software; you can redistribute it
 # and/or modify it under the terms of the GNU General Public License as
@@ -37,9 +37,10 @@ charset = utf-8
 indent_size = 4
 # isort plugin configuration
 known_first_party = invenio_search
-known_third_party = invenio_accounts, invenio_db, invenio_records
+known_third_party = invenio_query_parser
 multi_line_output = 2
 default_section = THIRDPARTY
+skip = .eggs
 
 # RST files (used by sphinx)
 [*.rst]

.gitignore

@@ -2,6 +2,9 @@
 __pycache__/
 *.py[cod]
 
+# Idea software family
+.idea/
+
 # C extensions
 *.so
 
@@ -54,3 +57,6 @@ docs/_build/
 
 # PyBuilder
 target/
+
+# Vim swapfiles
+.*.sw?

INSTALL.rst

@@ -1,2 +1,8 @@
 Installation
 ============
+
+Invenio-Search is on PyPI so all you need is:
+
+.. code-block:: console
+
+   $ pip install invenio-search

MANIFEST.in

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # This file is part of Invenio.
-# Copyright (C) 2015 CERN.
+# Copyright (C) 2015, 2017 CERN.
 #
 # Invenio is free software; you can redistribute it
 # and/or modify it under the terms of the GNU General Public License as
@@ -33,6 +33,7 @@ include LICENSE
 include MAINTAINERS
 include pytest.ini
 include tests/data/records/authorities/notajson
+prune docs/_build
 recursive-include docs *.bat *.py *.rst Makefile
 recursive-include examples *.json *.py *.sh *.txt
 recursive-include invenio_search *.py

docs/Makefile

@@ -87,9 +87,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/cookiecutterproject_name.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Invenio-Search.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/cookiecutterproject_name.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Invenio-Search.qhc"
 
 applehelp:
 	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@@ -104,8 +104,8 @@ devhelp:
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/cookiecutterproject_name"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/cookiecutterproject_name"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Invenio-Search"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Invenio-Search"
 	@echo "# devhelp"
 
 epub:

docs/api.rst

@@ -28,12 +28,6 @@ API Docs
 .. automodule:: invenio_search.api
    :members:
 
-Configuration
--------------
-
-.. automodule:: invenio_search.config
-   :members:
-
 Utilities
 ---------
 

docs/conf.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # This file is part of Invenio.
-# Copyright (C) 2015, 2016 CERN.
+# Copyright (C) 2015, 2016, 2017 CERN.
 #
 # Invenio is free software; you can redistribute it
 # and/or modify it under the terms of the GNU General Public License as
@@ -22,13 +22,19 @@
 # waive the privileges and immunities granted to it by virtue of its status
 # as an Intergovernmental Organization or submit itself to any jurisdiction.
 
+"""Sphinx configuration."""
+
 from __future__ import print_function
 
 import os
+import sys
 
 import sphinx.environment
 from docutils.utils import get_source_line
 
+# Plug example application into module path
+sys.path.append('examples')
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.

docs/configuration.rst

@@ -0,0 +1,29 @@
+..
+    This file is part of Invenio.
+    Copyright (C) 2017 CERN.
+
+    Invenio is free software; you can redistribute it
+    and/or modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation; either version 2 of the
+    License, or (at your option) any later version.
+
+    Invenio is distributed in the hope that it will be
+    useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Invenio; if not, write to the
+    Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+    MA 02111-1307, USA.
+
+    In applying this license, CERN does not
+    waive the privileges and immunities granted to it by virtue of its status
+    as an Intergovernmental Organization or submit itself to any jurisdiction.
+
+
+Configuration
+=============
+
+.. automodule:: invenio_search.config
+   :members:

docs/examplesapp.rst

@@ -0,0 +1,28 @@
+..
+    This file is part of Invenio.
+    Copyright (C) 2017 CERN.
+
+    Invenio is free software; you can redistribute it
+    and/or modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation; either version 2 of the
+    License, or (at your option) any later version.
+
+    Invenio is distributed in the hope that it will be
+    useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Invenio; if not, write to the
+    Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+    MA 02111-1307, USA.
+
+    In applying this license, CERN does not
+    waive the privileges and immunities granted to it by virtue of its status
+    as an Intergovernmental Organization or submit itself to any jurisdiction.
+
+
+Example application
+===================
+
+.. automodule:: app

docs/index.rst

@@ -1,6 +1,6 @@
 ..
     This file is part of Invenio.
-    Copyright (C) 2015, 2016 CERN.
+    Copyright (C) 2015, 2016, 2017 CERN.
 
     Invenio is free software; you can redistribute it
     and/or modify it under the terms of the GNU General Public License as
@@ -34,7 +34,9 @@ Invenio-Search.
    :maxdepth: 2
 
    installation
+   configuration
    usage
+   examplesapp
 
 
 API Reference

docs/make.bat

@@ -127,9 +127,9 @@ if "%1" == "qthelp" (
 	echo.
 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
 .qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\cookiecutterproject_name.qhcp
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Invenio-Search.qhcp
 	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\cookiecutterproject_name.ghc
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Invenio-Search.ghc
 	goto end
 )
 

invenio_search/config.py

@@ -2,7 +2,7 @@
 #
 # This file is part of Invenio.
 # Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2010, 2011, 2012, 2013,
-#               2015, 2016 CERN.
+#               2015, 2016, 2017 CERN.
 #
 # Invenio is free software; you can redistribute it
 # and/or modify it under the terms of the GNU General Public License as
@@ -25,20 +25,20 @@
 
 """Invenio Search Engine config parameters."""
 
-# SEARCH_ALLOWED_KEYWORDS -- a list of allowed keywords for the query parser.
 SEARCH_ALLOWED_KEYWORDS = []
-
+"""A list of allowed keywords for the query parser."""
 
 #
 # ELASTIC configuration
 #
 
-# SEARCH_ELASTIC_HOSTS -- list of hosts for Elasticsearch client.
-# http://elasticsearch-py.readthedocs.io/en/master/api.html#elasticsearch.Elasticsearch
 SEARCH_ELASTIC_HOSTS = None  # default localhost
+"""List of hosts for Elasticsearch client.
+
+Elasticsearch
+    <https://elasticsearch-py.readthedocs.io/en/master/api.html#elasticsearch.Elasticsearch>
+"""
 
-# SEARCH_ELASTIC_KEYWORD_MAPPING -- this variable holds a dictionary to map
-# invenio keywords to elasticsearch fields
 SEARCH_ELASTIC_KEYWORD_MAPPING = {
     None: ["_all"],
     "author": {
@@ -59,3 +59,4 @@
     "980__b": ["collections.secondary"],
     "542__l": ["information_relating_to_copyright_status.copyright_status"],
 }
+"""Holds a dictionary to map invenio keywords to elasticsearch fields."""

setup.cfg

@@ -33,3 +33,6 @@ all_files = 1
 
 [bdist_wheel]
 universal = 1
+
+[pydocstyle]
+add_ignore = D401

setup.py

@@ -48,7 +48,8 @@
 
 extras_require = {
     'docs': [
-        "Sphinx>=1.4.2",
+        'Sphinx>=1.5.6,<1.6',
+        'invenio-accounts>=1.0.0b1',
     ],
     'records': [
         'invenio-records>=1.0.0a4',
@@ -68,11 +69,12 @@
 
 install_requires = [
     'Flask>=0.11.1',
+    'Flask-Security>=1.7.5',
     'pyPEG2>=2.15.2',
     # NOTE: Overlays have to choose which elasticsearch version they want to
     # use and pin both elasticsearch and elasticsearch-dsl libraries.
     'elasticsearch>=2.0.0,<6.0',
-    'elasticsearch-dsl>=2.0.0,<6.0',
+    'elasticsearch-dsl>=2.0.0,<5.1.0',
     'invenio-query-parser>=0.4.1',
     'requests>=2.4.0',
 ]
@@ -90,7 +92,7 @@
     version=version,
     description=__doc__,
     long_description=readme + '\n\n' + history,
-    keywords='invenio TODO',
+    keywords='invenio search',
     license='GPLv2',
     author='CERN',
     author_email='[email protected]',
@@ -100,10 +102,10 @@
     include_package_data=True,
     platforms='any',
     entry_points={
-        'invenio_base.apps': [
+        'invenio_base.api_apps': [
             'invenio_search = invenio_search:InvenioSearch',
         ],
-        'invenio_base.api_apps': [
+        'invenio_base.apps': [
             'invenio_search = invenio_search:InvenioSearch',
         ],
     },
@@ -125,6 +127,6 @@
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: Implementation :: CPython',
         'Programming Language :: Python :: Implementation :: PyPy',
-        'Development Status :: 3 - Alpha',
+        'Development Status :: 4 - Beta',
     ],
 )

tests/test_examples_app.py

@@ -37,38 +37,46 @@
 def example_app():
     """Example app fixture."""
     current_dir = os.getcwd()
-    # go to example directory
+
+    # Go to example directory
     project_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
     exampleappdir = os.path.join(project_dir, 'examples')
     os.chdir(exampleappdir)
-    # setup example
+
+    # Setup example
     cmd = './app-setup.sh'
     exit_status = subprocess.call(cmd, shell=True)
     assert exit_status == 0
+
     # Starting example web app
     cmd = 'FLASK_APP=app.py flask run --debugger -p 5000'
     webapp = subprocess.Popen(cmd, stdout=subprocess.PIPE,
                               preexec_fn=os.setsid, shell=True)
     time.sleep(10)
-    # return webapp
+
+    # Return webapp
     yield webapp
-    # stop server
+
+    # Stop server
     os.killpg(webapp.pid, signal.SIGTERM)
-    # tear down example app
+
+    # Tear down example app
     cmd = './app-teardown.sh'
     subprocess.call(cmd, shell=True)
-    # return to the original directory
+
+    # Return to the original directory
     os.chdir(current_dir)
 
 
 def test_example_app(example_app):
     """Test example app."""
-    # load fixtures
+    # Load fixtures
     cmd = './app-fixtures.sh'
     exit_status = subprocess.call(cmd, shell=True)
     assert exit_status == 0
     time.sleep(10)
-    # open page
+
+    # Open page
     cmd = 'curl http://localhost:5000/?q=body:test'
     output = json.loads(
         subprocess.check_output(cmd, shell=True).decode('utf-8'))