global: release checklist

* FIX Adds changes according to release preparation checklist.

Signed-off-by: Paulina Lach <[email protected]>

.dockerignore

@@ -0,0 +1,15 @@
+.git
+*.gitignore
+
+*.mo
+*.pyc
+*.swp
+*.swo
+*.~
+
+.dockerignore
+Dockerfile
+docker-compose.yml
+docker-compose-dev.yml
+
+Procfile*

.editorconfig

@@ -39,6 +39,7 @@ indent_size = 4
 known_first_party = invenio_logging
 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
 
@@ -56,5 +59,6 @@ docs/_build/
 # PyBuilder
 target/
 
-#idea (BB)
-.idea/
+# Vim swapfiles
+.*.sw?
+

.travis.yml

@@ -46,6 +46,7 @@ python:
 matrix:
   allow_failures:
     - python: pypy
+  fast_finish: true
 
 before_install:
   - "travis_retry pip install --upgrade pip setuptools py"

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-logging` for local development.
 
-1. Fork the `invenio` repo on GitHub.
+1. Fork the `inveniosoftware/invenio-logging` 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.

INSTALL.rst

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

MANIFEST.in

@@ -28,18 +28,18 @@ include *.sh
 include *.txt
 include .dockerignore
 include .editorconfig
-include .tx/config
-include babel.ini
-include docs/requirements.txt
 include .lgtm
 include LICENSE
 include MAINTAINERS
+include docs/requirements.txt
 include pytest.ini
+prune docs/_build
 recursive-include docs *.bat
 recursive-include docs *.py
 recursive-include docs *.rst
 recursive-include docs Makefile
 recursive-include examples *.py
+recursive-include examples *.sh
 recursive-include invenio_logging *.html
 recursive-include misc *.py
 recursive-include misc *.rst

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

docs/conf.py

@@ -22,12 +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.
 
+"""Sphinx configuration."""
+
 from __future__ import print_function
 
 import os
+import sys
 
 import sphinx.environment
 
+# 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) 2015 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_logging.config
+   :members:

docs/index.rst

@@ -34,6 +34,7 @@ Invenio-Logging.
    :maxdepth: 2
 
    installation
+   configuration
    usage
 
 

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-Logging.qhcp
 	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\cookiecutterproject_name.ghc
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Invenio-Logging.ghc
 	goto end
 )
 

examples/app-fixtures.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+# quit on errors:
+set -o errexit
+
+# quit on unbound symbols:
+set -o nounset
+
+DIR=`dirname "$0"`
+
+cd $DIR
+export FLASK_APP=app.py
+
+# Setup fixtures

examples/app-setup.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+# quit on errors:
+set -o errexit
+
+# quit on unbound symbols:
+set -o nounset
+
+DIR=`dirname "$0"`
+
+cd $DIR
+export FLASK_APP=app.py
+
+# Setup app
+mkdir -p $DIR/instance

examples/app-teardown.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+# quit on errors:
+set -o errexit
+
+# quit on unbound symbols:
+set -o nounset
+
+DIR=`dirname "$0"`
+
+cd $DIR
+export FLASK_APP=app.py
+
+# Teardown app
+[ -e "$DIR/instance" ] && rm -Rf $DIR/instance

examples/app.py

@@ -23,27 +23,36 @@
 # as an Intergovernmental Organization or submit itself to any jurisdiction.
 
 
-"""Minimal Flask application example for development.
+"""Minimal Flask application example.
 
-Install requirements:
+First install Invenio-Logging, setup the application and load
+fixture data by running:
 
 .. code-block:: console
 
-    $ pip install -e .[all]
-    $ cd examples
+   $ pip install -e .[all]
+   $ cd examples
+   $ ./app-setup.sh
+   $ ./app-fixtures.sh
 
-Run example development server:
+Next, start the development server:
 
 .. code-block:: console
 
-    $ FLASK_APP=app.py flask run --debugger -p 5000
+   $ export FLASK_APP=app.py FLASK_DEBUG=1
+   $ flask run
 
-Test the demo:
+and open the example application in your browser:
 
 .. code-block:: console
 
-    curl -v -XGET 'http://localhost:5000/'
+    $ open http://127.0.0.1:5000/
 
+To reset the example application run:
+
+.. code-block:: console
+
+    $ ./app-teardown.sh
 """
 
 from __future__ import absolute_import, print_function
@@ -61,4 +70,4 @@
 def index():
     """Log error."""
     app.logger.error('Example error')
-    return 'Hello world!'
+    return 'Welcome to Invenio-Logging!'