daniil-berg
/
boilerplate-py
Template
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Boilerplate repository for Python projects intended to be packaged and distributed
4 Commits 1 Branch 0 Tags 62 KiB
Shell 77.1%
Python 22.9%
Go to file Use this template
Daniil Fajnberg 295c9ed6c7
Major overhaul: 
- transition to `pyproject.toml` config
- include license (Apache-2.0)
- add dev tools
- add documentation config (`mkdocs` based)
- turn `README.md` into a symlink to docs `index.md`
- add convenience scripts for testing and linting
 		2023-03-09 12:08:59 +01:00
.gitea Major overhaul: 2023-03-09 12:08:59 +01:00
docs Major overhaul: 2023-03-09 12:08:59 +01:00
requirements Major overhaul: 2023-03-09 12:08:59 +01:00
scripts Major overhaul: 2023-03-09 12:08:59 +01:00
src/package_name Major overhaul: 2023-03-09 12:08:59 +01:00
tests Major overhaul: 2023-03-09 12:08:59 +01:00
.gitignore Major overhaul: 2023-03-09 12:08:59 +01:00
LICENSE Major overhaul: 2023-03-09 12:08:59 +01:00
README.md Major overhaul: 2023-03-09 12:08:59 +01:00
mkdocs.yaml Major overhaul: 2023-03-09 12:08:59 +01:00
pyproject.toml Major overhaul: 2023-03-09 12:08:59 +01:00

README.md

${REPO_NAME}

${REPO_DESCRIPTION}

Usage

...

Installation

pip install ${REPO_NAME}

Dependencies

Python Version ..., OS ...