https://github.com/nickolasrm/python-package-template
Personal template for creating new python packages
https://github.com/nickolasrm/python-package-template
Last synced: 4 months ago
JSON representation
Personal template for creating new python packages
- Host: GitHub
- URL: https://github.com/nickolasrm/python-package-template
- Owner: nickolasrm
- License: mit
- Created: 2022-10-04T16:19:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-26T16:36:15.000Z (over 2 years ago)
- Last Synced: 2024-12-28T04:23:46.530Z (5 months ago)
- Language: Python
- Homepage:
- Size: 98.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# python-package-template
Personal template for creating new python packages
## Usage
In order to use this template, follow the steps below:
1. Install cookiecutter using `pip install cookiecutter`
2. Run `cookiecutter https://github.com/nickolasrm/python-package-template`
3. Fulfill the requested prompts
4. Run `make install`
5. Point to your GitHub Repo using: `git remote add origin `
## Features
- Cookiecutter generation
- MIT License
- Metadata consistency checking
- Changelog template
- Pull request template
- Poetry
- Pre-commit with Black, Pylint, Flake8, and Mypy
- Makefile lint, test, and install commands
- GitHub Actions release and build workflows