Changelog¶
All notable changes to pyprefab
are documented here.
The format is based on Keep a Changelog, and the project uses Semantic Versioning.
0.5.5¶
Added¶
.python-version
template for a more explicit uv experienceNew
LICENSE
template
Changed¶
Allow package creation in directories that already contain a
.git
folder (to prevent inadvertent overwriting, pyprefab will not create a package in a directory with existing content aside from.git/
)Include a note about Sphinx documentation preview on CONTRIBUTING.md.
0.5.4¶
Added¶
Include
__main__.py
in skeleton code generated by pyprefabTemplate for Dependabot configuration
Documentation now includes a section about GitHub-specific boilerplate files
Changed¶
Move logging setup out of
__init__.py
and intologging.py
Add explicit permissions to workflow file templates
Skip publish step by default in the PyPI-releated workflows (to prevent errors when test PyPI and PyPI have’t been configured for the package)
Fixed¶
Spinx warning caused by readme vs README inconsistent case
0.5.3¶
Changed¶
Entry point of generated app now displays additional output
--docs
parameter can now be set interactivelyREADME examples reflect that
--name
and--docs
options are interactive
0.5.2¶
Changed¶
Improve CHANGELOG aesthetics
Fail when target directory is not empty (instead of prompting)
Add colors and default values to CLI prompts
Fixed¶
Ensure pyprefab can run as
python -m pyprefab
0.5.1¶
Fixed¶
Fail docs build GitHub action on Sphinx error or warning
Correct pyprefab version retrieved during doc build
0.5.0¶
Added¶
Sphinx-based project documentation (published on GitHub pages)
New CLI
--docs
option to include skeleton documentation in created package
Fixed¶
Add escape character to quotation marks in author name and project description
0.4.0¶
Added¶
New templates for GitHub workflows: ci (linting, tests, and coverage), publishing to TestPyPI, and publishing to PyPI
Project changelog
New CHANGELOG.md template
New CONTRIBUTING.md template
Changed¶
Add CLI prompts as an alternate to passing command options
--directory
option renamed to--dir
Prompt user when specified project directory is not empty
List created package components on README.md
Add a link to CONTRIBUTING.md in the README.md template
Fixed¶
Correct CLI example on README.md
Fix pyproject.license build deprecation warning in pyproject.toml template
0.3.2¶
Changed¶
Rename CLI command to
pyprefab
0.3.1¶
Added¶
New templates for generating Python package boilerplate: .gitignore, README.md, app.py
Changed¶
Rename project to
pyprefab
Removed¶
Removed sample
hello_world
module in favor of template-driven boilerplate
0.3.0¶
Added¶
Added
pyproject.toml
template as the first piece of template-driven Python boilerplate
Removed¶
Removed artifacts from prior iteration of
pyprefab
that pre-dates the template-driven approach