Folders and files

This chapter explains the the folders and files present in this template.

/src

This folder should contain all your code. All py-files with DocStrings in this folder are included in the AutoDoc.

/tests

This folder contains your tests. The files should be named ‘test_*.py’

/docs

Contains the documentation files. See documentation section for more information.

.gitignore

Files and folders git should not upload from your local working copy.

.pylintrc

Configuration file for linters.

CHANGELOG.md

Contains info about changes. The newest changes should always be on top.

README.md

A readme. This file is shown on github under the repository.