global: release checklist

* FIX Adds changes according to release preparation checklist.

Signed-off-by: Rémi Ducceschi <remi.ducceschi@gmail.com>

.editorconfig

@@ -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
@@ -22,7 +22,6 @@
 # waive the privileges and immunities granted to it by virtue of its status
 # as an Intergovernmental Organization or submit itself to any jurisdiction.
 
-
 root = true
 
 [*]
@@ -40,6 +39,7 @@ known_first_party = invenio_rest
 known_third_party = flask_limiter, flask_cors
 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
 
@@ -45,7 +48,6 @@ coverage.xml
 
 # Translations
 *.mo
-*.pot
 
 # Django stuff:
 *.log
@@ -55,3 +57,6 @@ docs/_build/
 
 # PyBuilder
 target/
+
+# Vim swapfiles
+.*.sw?

.travis.yml

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # This file is part of Invenio.
-# Copyright (C) 2015 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,14 +22,18 @@
 # waive the privileges and immunities granted to it by virtue of its status
 # as an Intergovernmental Organization or submit itself to any jurisdiction.
 
-
 notifications:
   email: false
 
 sudo: false
 
 language: python
 
+matrix:
+  fast_finish: true
+  allow_failures:
+    - python: pypy
+
 cache:
   - pip
 
@@ -43,11 +47,6 @@ python:
   - "3.5"
   - "pypy"
 
-matrix:
-  fast_finish: true
-  allow_failures:
-    - python: pypy
-
 before_install:
   - "travis_retry pip install --upgrade pip setuptools py"
   - "travis_retry pip install twine wheel coveralls requirements-builder"

AUTHORS.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
@@ -21,11 +21,11 @@
     waive the privileges and immunities granted to it by virtue of its status
     as an Intergovernmental Organization or submit itself to any jurisdiction.
 
-
 Authors
 =======
 
 REST API module for Invenio.
 
-- Lars Holm Nielsen <lars.holm.nielsen@cern.ch>
 - Jiri Kuncar <jiri.kuncar@cern.ch>
+- Lars Holm Nielsen <lars.holm.nielsen@cern.ch>
+- Rémi Ducceschi <remi.ducceschi@gmail.com>

CHANGES.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
@@ -21,7 +21,6 @@
     waive the privileges and immunities granted to it by virtue of its status
     as an Intergovernmental Organization or submit itself to any jurisdiction.
 
-
 Changes
 =======
 

CONTRIBUTING.rst

@@ -53,9 +53,9 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `invenio` for local development.
+Ready to contribute? Here's how to set up `invenio-rest` for local development.
 
-1. Fork the `invenio` repo on GitHub.
+1. Fork the `inveniosoftware/invenio-rest` repo on GitHub.
 2. Clone your fork locally:
 
    .. code-block:: console
@@ -95,7 +95,12 @@ Ready to contribute? Here's how to set up `invenio` for local development.
    .. code-block:: console
 
       $ git add .
-      $ git commit -s -m "Your detailed description of your changes."
+      $ git commit -s
+          -m "component: title without verbs"
+          -m "* NEW Adds your new feature."
+          -m "* FIX Fixes an existing issue."
+          -m "* BETTER Improves and existing feature."
+          -m "* Changes something that should not be visible in release notes."
       $ git push origin name-of-your-bugfix-or-feature
 
 7. Submit a pull request through the GitHub website.
@@ -109,5 +114,5 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring.
 3. The pull request should work for Python 2.7, 3.3, 3.4 and 3.5. Check
-   https://travis-ci.com/inveniosoftware/invenio-rest/pull_requests
+   https://travis-ci.org/inveniosoftware/invenio-rest/pull_requests
    and make sure that the tests pass for all supported Python versions.

INSTALL.rst

@@ -15,16 +15,6 @@ this:
 
    $ pip install invenio-rest[cors]
 
-Configuration
--------------
-
-===================== =================================================
-`REST_ENABLE_CORS`    Set to ``True`` to enable Cross-Origin Resource
-                      Sharing. Defaults to ``False``.
-`REST_CORS_RESOURCES` Dictionary for configuring CORS for endpoints.
-                      See Flask-CORS for further details.
-===================== =================================================
-
 Please also see
 `Flask-Limiter <https://flask-limiter.readthedocs.io/en/stable/>`_ and
 `Flask-CORS <https://flask-cors.readthedocs.io/en/latest/>`_ for many more

MANIFEST.in

@@ -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
@@ -27,8 +27,8 @@ include *.sh
 include *.txt
 include .dockerignore
 include .editorconfig
-include .tx/config
 include .lgtm
+include .tx/config
 include LICENSE
 include MAINTAINERS
 include babel.ini

README.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
@@ -40,10 +40,11 @@
 .. image:: https://img.shields.io/github/license/inveniosoftware/invenio-rest.svg
         :target: https://github.com/inveniosoftware/invenio-rest/blob/master/LICENSE
 
-
 REST API module for Invenio.
 
 *This is an experimental developer preview release.*
 
-* Free software: GPLv2 license
-* Documentation: https://invenio-rest.readthedocs.io/
+* This module allows you to create a REST API with standard error codes...
+
+Further documentation is available on
+https://invenio-rest.readthedocs.io/

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-REST.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/cookiecutterproject_name.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Invenio-REST.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-REST"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Invenio-REST"
 	@echo "# devhelp"
 
 epub:

docs/api.rst

@@ -1,6 +1,6 @@
 ..
     This file is part of Invenio.
-    Copyright (C) 2015 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
@@ -28,12 +28,6 @@ API Docs
 .. automodule:: invenio_rest.ext
    :members:
 
-Configuration
--------------
-
-.. automodule:: invenio_rest.config
-   :members:
-
 Decorators
 ----------