A Project Template With Python

Annotation AI

Last update: Jan 2, 2023

Related tags

Boilerplate python-project-template

Overview

File Structure

.
├── LICENSE
├── Makefile          # commands
├── README.md
├── requirements.txt  # package information
├── setup.cfg         # configurations for formatting & linting & unit-test
├── src               # source code location
└── test
    └── utest         # unit tests location

Commands

$ make env      # create anaconda environment
$ make setup    # initial setup for the project
$ make format   # format python scripts
$ make lint     # lint python scripts
$ make utest    # run unit tests
$ make cov      # open coverage report (after `make utest`)

Configurations

setup.cfg states all configurations for formatting & linting & unit-test.

Verifications

per commit: pre-commit hook runs formatting and linting.
per pull-request: GitHub Actions check formatting, linting, and unit-test results.

Recommended Repository Settings

Restriction on multi-commit pushes

Settings -> General -> Merge botton -> Allow squash merging ONLY

Branch Protection Rules

Settings -> Branches -> Branch protection rules -> Add rule

Branch name pattern: main
Require a pull request before merging & Require approvals
Require status checks to pass before merging & Require branches to be up to date before merging
Include administrators

You might also like...

A cookiecutter template for python scripts

cookiecutter-py-script A cookiecutter template for python scripts Prerequisites Git Usage pip install cookiecutter

1 Dec 14, 2022

Bleeding edge django template focused on code quality and security.

wemake-django-template Bleeding edge django2.2 template focused on code quality and security. Purpose This project is used to scaffold a django projec

1.6k Jan 4, 2023

Bleeding edge django template focused on code quality and security.

wemake-django-template Bleeding edge django2.2 template focused on code quality and security. Purpose This project is used to scaffold a django projec

1.6k Jan 8, 2023

Django Webpack starter template for using Webpack 5 with Django 3.1 & Bootstrap 4. Yes, it can hot-reload.

Django Webpack Starter Hello fellow human. The repo uses Python 3.9.* Django 3.1.* Webpack 5.4.* Bootstrap 4.5.* Pipenv If you have any questions twe

56 Nov 28, 2022

A Django starter template with a sound foundation.

SOS Django Template SOS Django Tempalate is a Django starter template that has opinionated and good solutions while starting your new Django project.

19 Oct 30, 2022

Template repository to build PyTorch projects from source on any version of PyTorch/CUDA/cuDNN.

651 Dec 12, 2022

A template repository implementing HTML5 Boilerplate 8.0 in Sanic using the Domonic framework.

sanic-domonic-h5bp A template repository implementing HTML5 Boilerplate 8.0 in Sanic using the Domonic framework. If you need frontend interactivity,

3 Dec 12, 2022

Basic Docker Compose template application with Flask, Celery, Redis, MySQL, SocketIO, Nginx and Gunicorn.

Nginx / Gunicorn / Flask 🐍 / Celery / SocketIO / MySQL / Redis / Docker 🐳 sample application Basic Docker Compose template application for orchestat

8 Aug 6, 2022

A template repo for use in the Advent of Code

AoC-Template A template repo for use in the Advent of Code The README_template.md must contain "STATS_TABLE" to be replaced by the generated table, an

0 Jan 14, 2022

Comments

Update configs for further uses
Fix #8

Updates

deprecated flake8-spellcheck.

deprecated some pylint checks which are not recommended.

updated type check information for the frequently used packages.

added statement for this repo in README.md

enhancement
opened by Curt-Park 0
Ignore `ANN101` in flake8
ANN101 forces to annotate the type of self in class methods. It's too verbose, so we usually ignore the type annotation for self.

See PEP-673

this is verbose and unintuitive. Because self is usually not explicitly annotated, the above solution doesn't immediately come to mind, ...
enhancement
opened by Curt-Park 0
`conda install` needs channel information

AS-IS

make setup doesn't specify channel information. It cannot fetch package information in some environments.

TO-BE

Makefile specifies channel information for package installs.

Furthermore, we should consider the duplicate information at the channel information in the GitHub Actions workflow.
bug

opened by Curt-Park 0