default-py-template

Default Python project template with linter, type checking and test environment setup. Also supporting github auto-running tests on push to repository.

Use

To use this project's structure in a new project without leaving dependency on this stub project:

git clone https://github.com/kilgoretrout1985/default-py-template.git yourrealprojectname
cd yourrealprojectname
rm -drf .git
git init .

2. Search all occurences of projectname in project files (and in dir- and file-names!) and replace them with yourrealprojectname.

3. Browse setup.cfg and README.md to change author name, email and github links to the actual ones.

python3 -m venv .env && \
source .env/bin/activate && \
pip install -U pip && \
pip install -e .[dev]

More on pip install -e . here.

5. Run tox command to check your project setup. Everything should be green at this point.

Happy commits!

(c)

This repo is mainly based on this video.