https://github.com/innerlee/python-template
python-template
https://github.com/innerlee/python-template
Last synced: 9 months ago
JSON representation
python-template
- Host: GitHub
- URL: https://github.com/innerlee/python-template
- Owner: innerlee
- Created: 2020-01-08T12:49:33.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-04T02:19:14.000Z (almost 6 years ago)
- Last Synced: 2025-02-11T14:46:51.497Z (11 months ago)
- Language: Python
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# python template
This is a template project for python projects.
## Features
- Pre-commit with `isort`, `yapf`, `flake8`, `trailing-whitespace`, `markdown`, etc.
- Setup script.
## Usage
- Clone the repo and delete the `.git/` folder
- Change the `template` folder to your `projectname`.
- Replace all `template` word in `setup.py` with your `projectname`.
## Development Guide
```bash
# install formatter
pip install yapf
# install pre-commit tool
pip install pre-commit
pre-commit install
# manually check all files
pre-commit run --all-files
```
## Install
```bash
# for development
python setup.py develop
# for deploy
python setup.py install
```