https://github.com/frgfm/pypackage-template
Template for Python packages
https://github.com/frgfm/pypackage-template
cookiecutter python3 template-project
Last synced: 2 months ago
JSON representation
Template for Python packages
- Host: GitHub
- URL: https://github.com/frgfm/pypackage-template
- Owner: frgfm
- License: apache-2.0
- Created: 2022-06-25T13:13:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-20T15:53:14.000Z (over 2 years ago)
- Last Synced: 2024-12-29T17:41:31.823Z (4 months ago)
- Topics: cookiecutter, python3, template-project
- Language: Python
- Homepage:
- Size: 53.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Template for Python packages
Kicking off a Python package project? Why not starting with a high-quality basis?
## Quick Tour
### Cookie cutter
Templating Python projects is now very accessible thanks to [CookieCutter](https://github.com/cookiecutter/cookiecutter). You can use this template easily by using the following command:
```shell
cookiecutter gh:frgfm/pypackage-template
```
The command will interactively ask you to fill some information to generate the project.
## Setup
Python 3.6 (or higher), [pip](https://pip.pypa.io/en/stable/) and [Git](https://git-scm.com/) are required to run this project.
```shell
git clone https://github.com/frgfm/pypackage-template.git
pip install -r pypackage-template/requirements.txt
```
## Contributing
Feeling like I missed a fancy new feature that is worth adding to all Python packages? Any sort of contribution is greatly appreciated!
You can find a short guide in [`CONTRIBUTING`](CONTRIBUTING) to help grow this project!
## License
Distributed under the Apache 2.0 License. See [`LICENSE`](LICENSE) for more information.