Skip to content
/ python-template Public template

python project template for personal projects! πŸ™‹β€β™€οΈ

Notifications You must be signed in to change notification settings

codertimo/python-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

12 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

REPO-README

Template for my python projects

Template Replace Check-List

  • Make your own package name πŸ‘‹
  • Replace package/ to new package name πŸŽ‰
  • Replace command in .github/workflows/main.yml with new package name πŸ”¨
  • Replace command in Makefile with new package name
  • Replace name, description, author etc in setup.py with new package setting πŸ„β€β™‚οΈ
  • Replace author, version in package/__init__.py to new package name
  • Setting codecov (https://docs.codecov.io/docs/quick-start) to your repo
  • Make REAL runnable code πŸ‘¨β€πŸ’»
  • Make REAL test code πŸ‘©πŸ»β€πŸ’»
  • Remove this README and make your own story! πŸ‘

Run Scripts

All runnable python scripts should be located in scripts/ folder

And you can run the scripts through under command

python -m scripts.run_sample

Run Linting

This project use three Linter: black, isort, flake8

# use linter to fix code format
make style

# check lint error
make quality

Run Test

All runnable test codes should be located in tests/ folder

pytest

Author

by @codertimo

About

python project template for personal projects! πŸ™‹β€β™€οΈ

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published