Python Default Project

Setup

1. Install pipenv. You might want to set export PIPENV_VENV_IN_PROJECT=1 in your .bashrc/.zshrc for local virtual environments. Thereby you are making sure that all dependencies for your application are stored in the same directory under the .venv folder.

2. Clone repository into preferred directory (or simply download the source code and rename the folder as you like): git clone https://github.com/jomazi/Python-Default

3. Install packages: cd Python-Default && pipenv install --dev

4. Init .env file. Use this file to store all your environment variables, such as credentials or encryption phrases. This file should never be added to your public repository but should always stay local: mv .example.env .env

5. Activate virtual environment: pipenv shell

6. Test setup: pipenv run main

7. Install Git hooks. They help you to execute tasks before your code is committed (see Working with Git). Learn more about pre-commit in the official docs. (Installation and Activation are described here) In our case they are used to make sure that the application code is well formatted using black/autopep8, has no syntax errors using flake8 and that the dependency imports are well sorted using isort. The pre-commit instructions are given by the .pre-commit-config.yaml. Any isort specific settings are given by the .isort.cfg file.

Note: To deactivate the environment again, simply run deactivate.

Testing

A script to automatically execute tests is already defined in the project's Pipfile. Therefore you can simply run: pipenv run test To generate a report on code coverage alongside run: pipenv run test && pipenv run report

Working with Git

In case you do not know about Git yet it is now time to make yourself familiar with it :) There are already plenty of very good tutorials about Git out there which is why we refer to them. For a good introduction written in German you might want to go to Roger Dudler's awesome post.

Git Workflow

To coordinate the software development process a set of guidelines are necessary. It is helpful to rely on the GitHub Flow strategy which defines a branch-based workflow. Essentially, it boils down to the following steps:

1. Create a main/master branch. This is done automatically by creating a new project.
2. Create an issue that describes a bug or asks for an additional feature.
3. Add features or solve bug fixes by creating new branches via git checkout. Those branches should be named feature-* or fix-* accordingly. Assign the issue that the code changes are meant to solve.
4. Commit to new feature or fix branch. Make sure that you also write tests which cover the new features or show that the bug is solved. They should run automatically using the GitHub CI system. Having a CI system set up is not mandatory but helps a lot to avoid mistakes during the development process.
5. Create pull request once you are done with your work. Use the @mention system to get the maintainer's attention or ask questions to specific people.
6. Optional discussion about the pull request. If necessary, additional changes can be made.
7. New branch is merged into main/master branch.

Packaging

Packaging a Python application is not as trivial as it seems to be. A good introduction into this topic is given by the official docs. In any case you should always make sure that your program has only one entry point. In this example project it is the src/main.py file.

Important Note

Leave a star ⭐ ;)