WIP global: new module

CONTRIBUTING.rst

@@ -0,0 +1,113 @@
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/inveniosoftware/invenio-pidstore/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "feature"
+is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Invenio-PIDStore could always use more documentation, whether as part of the
+official Invenio-PIDStore docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at
+https://github.com/inveniosoftware/invenio-pidstore/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `invenio` for local development.
+
+1. Fork the `invenio` repo on GitHub.
+2. Clone your fork locally:
+
+   .. code-block:: console
+
+      $ git clone git@github.com:your_name_here/invenio-pidstore.git
+
+3. Install your local copy into a virtualenv. Assuming you have
+   virtualenvwrapper installed, this is how you set up your fork for local
+   development:
+
+   .. code-block:: console
+
+      $ mkvirtualenv invenio-pidstore
+      $ cd invenio-pidstore/
+      $ pip install -e .[all]
+
+4. Create a branch for local development:
+
+   .. code-block:: console
+
+      $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass tests:
+
+   .. code-block:: console
+
+      $ ./run-tests.sh
+
+   The tests will provide you with test coverage and also check PEP8
+   (code style), PEP257 (documentation), flake8 as well as build the Sphinx
+   documentation and run doctests.
+
+6. Commit your changes and push your branch to GitHub:
+
+   .. code-block:: console
+
+      $ git add .
+      $ git commit -s -m "Your detailed description of your changes."
+      $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests and must not decrease test coverage.
+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-pidstore/pull_requests
+   and make sure that the tests pass for all supported Python versions.

INSTALL.rst

@@ -0,0 +1,2 @@
+Installation
+============

MANIFEST.in

@@ -22,19 +22,15 @@
 # waive the privileges and immunities granted to it by virtue of its status
 # as an Intergovernmental Organization or submit itself to any jurisdiction.
 
-include *.py
-include *.rst
-include *.txt
-include .dockerignore .editorconfig .travis.yml .travis.invenio.cfg
-include LICENSE
-include babel.ini
-include pytest.ini
-include tox.ini
-recursive-include docs *.bat
-recursive-include docs *.py
-recursive-include docs *.rst
-recursive-include docs Makefile
-recursive-include invenio_pidstore *.mo
-recursive-include invenio_pidstore *.po
-recursive-include invenio_pidstore *.pot
-recursive-include invenio_pidstore *.py
+
+# TODO: Generate this manifest file by running the following commands:
+#
+#  git init
+#  git add -A
+#  pip install -e .[all]
+#  check-manifest -u
+
+# Check manifest will not automatically add these two files:
+include .dockerignore
+include .editorconfig
+include .tx/config

babel.ini

@@ -1,19 +1,26 @@
+# -*- coding: utf-8 -*-
+#
 # 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
+# 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
+# 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.A
+# 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.
 
 # Extraction from Python source files