Example repository

This is an example repository of how Python projects should be organized as at QIM.

File structure

On the root of the repository, at minimum you should have:

• README.md
• LICENSE
• An .gitignore file (you can use the one from here as a base template)
• A single project_name directory that contains all the main code
• requirements.txt (for the pip requirements)

Code directory

Use a simple but meaningful name, as this is the name you're project is going to be imported in case it is packed as a library.

Here we use qimer as in QIM Example

Coding guidelines

Testing