Install, run and test

As soon as you have run the Cookiecutter, you have a valid module that can be installed. In this section, we are going to see how to install the module, run the tests, run the example application and build the documentation.

Before that, we need to stop any running Invenio instance.

Install the module

Install the module is very easy, you just need to go to the root directory of the module and run the command:

pip install -e .[all]

Some explanations about the command:

  • the -e option is used for development. It means that if you change the files in the module, you won’t have to reinstall it to see the changes. In a production environment, this option shouldn’t be used.
  • the . is in fact the path to your module. As we are in the root folder of the module, we can just say here, which is what the dot means
  • the [all] after the dot means we want to install all dependencies, which is common when developing. Depending on your use of the module, you can install only parts of it:
    • the default (nothing after the dots) installs the minimum to make the module run
    • [tests] installs the requirements to test the module
    • [docs] installs the requirements to build the documentation
    • some modules have extra options

You can chain them: [tests, docs].

Run the tests

In order to run the tests, you need to have a valid git repository. The following step needs to be run only once. Go in the root folder of the module:

git init
git add -A
check-manifest -u

What we have done:

  • change the folder into a git repository, so it can record the changes made to the files
  • add all the files to this repository
  • update the file

Now, we are able to run the tests:


Everything should pass as we didn’t change any files yet.

Run the example application

The example application is a small app that presents the features of your module. By default, it simply prints a welcome page. To try it, go into the examples folder and run:

export FLASK_DEBUG=1
flask run

You can now open a browser a go to the URL http://localhost:5000/ you should be able to see a welcome page.

To clean the server, run the ./ script after killing the server.

Build the documentation

The documentation can be built with the script, but you need the tests requirements, and run the tests. If you just want to build the documentation, you will only need the docs requirements (see the install section above) and run:

python build_sphinx

Before going further

Before going further in the tutorial, we need to push our repository to GitHub. The details about GitHub are explained in Setting up your development environment.

The first thing is to create a repo on GitHub, we will globally follow the GitHub documentation:

First, create an empty repository in your GitHub account. Be sure to not generate any .gitignore or README files, as our code already has them. If you don’t have a GitHub account, you can skip this step, it is only necessary if you plan to publish your module on PyPI.

Now, go into the root directory of your module, and run

git remote add origin URL OF YOUR GITHUB REPO

Now, we can commit and push the generated files:

git commit -am "first commit"
git push --set-upstream origin master

Finally, we create a new branch to develop on it

git checkout -b dev