Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shapiromatron/pyscaffold
An opinionated Python package template
https://github.com/shapiromatron/pyscaffold
Last synced: 2 days ago
JSON representation
An opinionated Python package template
- Host: GitHub
- URL: https://github.com/shapiromatron/pyscaffold
- Owner: shapiromatron
- License: mit
- Created: 2021-07-15T15:51:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-22T03:47:00.000Z (5 days ago)
- Last Synced: 2025-01-22T04:25:48.549Z (5 days ago)
- Language: Python
- Homepage:
- Size: 23.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
# pyscaffold
An opinionated starter template for setting up a python 3.12+ package with a CLI.
NOTE: this project is unrelated to the excellent [PyScaffold](https://pypi.org/project/PyScaffold/) project. This repo will likely not be published to pypi, and handles a much smaller and more narrow use case. Apologies in advance for the confusion in naming.
## Customize for your project...
To customize for your own package:
1. Search & replace `pyscaffold` and replace with `yourproject` (or whatever you want to call it).
- includes source code, tests, and this readme!
- rename the `pyscaffold` project and test folder too
2. Review pyproject.toml; change `authors`, `classifiers`, `project.urls`, etc.
3. Follow the "Developer setup" section below
4. Update this readme! Delete this section, edit quickstart guide, etc.
This is a manual [cookiecutter](https://github.com/cookiecutter/cookiecutter). This was done intentionally; keeping it a manual job is nice for testing because it makes it easier to ensure that our github actions work as expected.
## Quickstart
Make sure you have python 3.12 available and on your path. Then:
```bash
# update pip
python -m pip install -U pip
# if it's local file or a github link...
pip install path/to/pyscaffold-0.0.3-py3-none-any.whl
# if it's on pypi
pip install pyscaffold
# test our CLI
pyscaffold --help
pyscaffold hello
pyscaffold hello --name Andy
pyscaffold bottles --num 20
```
## Developer setup
Make sure you have uv available on your path. Then:
```bash
# clone project
git clone [email protected]:shapiromatron/pyscaffold.git
cd pyscaffold
# create virtual environment and activate
uv venv --python=3.12 --prompt pyscaffold .venv
source venv/bin/activate # or venv\Scripts\activate on windows.
# install packages
uv pip install -e ".[dev]"
# test local install
pyscaffold hello
# run assorted commands
poe --help
poe test # run tests
poe lint # identify formatting errors
poe format # fix formatting errors when possible
poe build # build a python wheel
```
Github actions are setup to execute whenever code is pushed to check code formatting and successful tests. In addition, when code is pushed to the `main` branch, a wheel artifact is created and stored on github.