blank-project 0.3.0

Description:

blankproject 0.3.0

blank-project






A dummy package for quickly starting typical Python projects.
Features:

Basic .gitignore;
GitHub actions for builds and checks;
Acceptable directory structure at once;
Regular automation based on a Makefile;
Templates for basic Python badges into README.md.
Single point of project specification - pyproject.toml;
Acceptable settings for: black, isort, flake8, mypy, pydocstyle and coverage;

Usage

Clone repo:

$ git clone https://git.peterbro.su/peter/py3-blank-project.git


Run init.sh with your project name:

$ cd py3-blank-project
$ NAME=<projname> \
VERSION=<version|0.1.0> \
AUTHOR=<name> \
EMAIL=<author email> \
LICENSE=<license|MIT> \
./init.sh && cd -P .



Change description, keywords and classifiers into pyproject.toml.


Change README.md and LICENSE files.


A new blank Python project is ready, create gh-repo and go forward!
Available make commands
Dependencies

make deps-dev - Install only development dependencies.
make deps-build - Install only build system dependencies.
make deps - Install all dependencies.

Distributing

make build-sdist - Build a source distrib.
make build-wheel - Build a pure Python wheel distrib.
make build - Build both distribs (source and wheel).
make upload - Upload built packages to PyPI.

Development

make cleanup - Clean up Python temporary files and caches.
make format - Fromat the code (by black and isort).
make lint - Check code style, docstring style and types (by flake8, pydocstyle and mypy).
make tests - Run tests with coverage measure (output to terminal).
make tests-cov-json - Run tests with coverage measure (output to json [coverage.json]).
make tests-cov-html - Run tests with coverage measure (output to html [coverage_report/]).