Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evamaxfield/cookiecutter-py-package
Yet another cookiecutter for a Python project.
https://github.com/evamaxfield/cookiecutter-py-package
cookiecutter cookiecutter-pypackage python
Last synced: 3 months ago
JSON representation
Yet another cookiecutter for a Python project.
- Host: GitHub
- URL: https://github.com/evamaxfield/cookiecutter-py-package
- Owner: evamaxfield
- License: mit
- Created: 2022-07-14T20:16:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T17:48:34.000Z (11 months ago)
- Last Synced: 2024-10-07T19:42:32.720Z (3 months ago)
- Topics: cookiecutter, cookiecutter-pypackage, python
- Language: Python
- Homepage:
- Size: 82 KB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Cookiecutter Py Package
[](https://github.com/evamaxfield/cookiecutter-py-package/actions)
Yet another Cookiecutter template for a Python package.
## About
`Cookiecutter` is a Python package to generate templated projects.
This repository is a template for `cookiecutter` to generate a Python project which
contains following:
- A directory structure for your project
- Prebuilt `pyproject.toml` file to help you develop and install your package
- Includes basic examples of modules, tests, bin scripts, etc.
- Continuous integration
- Preconfigured to generate project documentation
- Preconfigured to automatically run tests every time you push to GitHub
- Preconfigured to help you release your package publicly (PyPI)
We think that this template provides a good starting point for any Python project.
## Quickstart
To use this template use the following commands.
1. `pip install cookiecutter`
2. `cookiecutter gh:evamaxfield/cookiecutter-py-package`
Once the project is generated, move to the newly created project directory
and follow the instructions in `SETUP.md`.
### Notes
1. Requires `setuptools>=64.0` to install library locally in editable mode
* Most environment managers pull in the latest `setuptools` automatically when
creating a new environment anyway.
2. Must initialize the project as a `git` repository prior to installing locally.
* This is due to the dynamic version management with `setuptools-scm`.
* After running the cookiecutter, you should push code to a remote host
(GitHub, GitLab, etc.) or at the very least, run `git init` prior to install.
3. It is generally recommended to use VSCode and install the extensions for
black and ruff.
## Features
- Uses `pytest` for local testing, simply run `just build` from a terminal.
- Runs tests on Windows, Mac, and Ubuntu on every commit to `main` and
every commit to branches with an open `pull request` to `main` using
GitHub Actions.
- Releases your Python Package to PyPI when you push to `main` after pushing a new
git tag with `just tag-for-release` and `just release`.
- Automatically builds documentation using Sphinx on every push to `main` and deploys
to GitHub Pages.
- Includes very minimal example code to get started.
List of available [just](https://github.com/casey/just) commands:
```bash
just
```
```
Available recipes:
build # run lint and then run tests
clean # clean all build, python, and lint files
default # list all available commands
generate-docs # generate Sphinx HTML documentation
install # install with all deps
lint # lint, format, and check all files
release # release a new version
serve-docs # generate Sphinx HTML documentation and serve to browser
tag-for-release version # tag a new version
test # run tests
update-from-cookiecutter # update this repo using latest cookiecutter-py-package
```