A dummy package for quickly starting typical Python projects.
Project description
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
andcoverage
;
Usage
- Clone repo:
$ git clone https://github.com/p3t3rbr0/py3-blank-project.git
- Rename project directory name on your choice:
$ mv py3-blank-project <py3-project-name>
- Run init.sh with your project name:
$ cd <py3-project-name>
$ NAME=<project-name> ./init.sh
- Remove init.sh
$ rm -f init.sh
-
Change
authors
,description
,keywords
andclassifiers
into pyproject.toml. -
Change
README.md
,CHANGELOG.md
andLICENSE
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/]).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
blank_project-0.1.0.tar.gz
(4.5 kB
view hashes)
Built Distribution
Close
Hashes for blank_project-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d8f4679fca14a765c33e6cac8dbeab890096cb9891cb0dd817449d40f69b0cd |
|
MD5 | 0a42eebbbb1d9caa6ab9e7087a919ea2 |
|
BLAKE2b-256 | 000eac7b22dc1dc962b8474174c4d9a5dc1ddd14e0ee8e407ee18822cecbb2d6 |