First Steps


After installation, edit then type . hatching in the terminal. When the process is finished, type . You’re all set!

Hello World

Before using nQb8or, please clone the repository and install the prerequisites as described in the installation section. Once this is done, you may configure your new project by editing the file. Change the project name, author, remote repository etc.

If you want to use a remote repository, it is the right time to create it (create an empty one, all the required files to start your project will be added by nQb8or).

Then you may start the project creation by opening a terminal and typing the following command:


This will create a directory for your new project and generate the required structure to start developping quickly. Make sure that you read the messages to check that every step passes without errors. You will also have to confirm a couple of steps.

When this script ends, it will move to your project directory, create an initial commit and activate the project virtualenv (if you didn’t change corresponding parameters in the default file). At this point, you should launch the quickstart script to generate a first version of the documentation. This can be done by entering the following command in the terminal:


Before building the documentation, the code is tested by running pytest on test files stored in the tests directory. When the documentation is built, it will be commited to your local git repository and a page will open in your browser (local version of the documentation). If you are using a remote repository, the changes will be pushed to this repository (if you don’t want to use a remote repo, you should edit the script and comment the line with the push command”.

A few steps further

You may now start editing the files that nQb8or prepared for you to customize your project. A good starting point is editing the and docs/source/index.rst files to describe your project. Then you may create a cool logo for your project. The logo that should be copied to docs/source/_static/logo.png. A similar thing may be done for the welcome banner. Once this is done, you should rebuild the documentation using the following command in the terminal:


This command with also make a commit and push it to your remote repository.

If you want to share your documentation on the website, sign-in on that website and configure a build pointing to your remote repository (you may use a webhookfor automated builts). The .readthedocs.yaml file in the project directory is a configuration file that may be edited for tuning the built.


By default, the file is set to run each example notebook when building the docs. You may change the nbsphinx_execute to ‘auto’ or ‘never instead of ‘always’ depending on your needs.

Be aware that the docs directory contains a requirements.txt that can be used to build the documentation on the website. You will have to specify the relative path to that file in the advanced settings under the Admin section of the readthedocs interface.

By default the script makes a copy of the project requirements.txt in the docs. I you want to alter this, just comment the cp line in

Start developping your project

You are now ready to start developping your package or application. You could start by editing the fake class and function in core/

Make sure to document your code using numpy style docstrings.

You should also modify the unit test accordingly (by default pytest is used). If you create new test files make sure to put them in the tests directory and name them following this pattern: “test_*.py”.

You may check that all tests pass with the following command:


Once this is done, add your modifications to a commit with commands like this one:

git add core/ tests/
git commit -m "Adds first functionalities to core.core as well as the related tests"

Then rebuild the documentation with the same command as before:


The two commits will be pushed to your remote repository.


When collaborating on a project you should make sure that your local copy is clean and pull from remote before pushing

Some final tips

If you feel that some operations are still unclear, deepen your knowledge on

  • coding with python, documenting code with docstrings and writing tests with pytest

  • writing example code with jupyter

  • using git for tracking changes in files

  • using internet hosting services for sofware development under git (such as gitlab or github)

  • the RestructuredText (rst) syntax

  • using the sphinx documentation tool and the nbsphinx extension

  • using the services.