NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI
PyPI, #3304 most downloaded on PyPI
Template tool for putting up the scaffold of a Python project
Latest stable
4.6
Last release 2 years ago
no release in 18 months
Ships unpredictably
gaps range from 9 days to 1.3 years
Nearly every release is documented
notes for 59 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
13 years old
179 releases · first in 2014
Drag across the ruler to compare, or tap a release to open it.
Modify Cirrus CI template to save resources, https://github.com/pyscaffold/pyscaffold/pull/735
importlib.resources.files instead of importlib.resources.read_text or pkgutil.get_data, https://github.com/pyscaffold/pyscaffold/pull/747platformdirs, https://github.com/pyscaffold/pyscaffold/pull/755Full Changelog: https://github.com/pyscaffold/pyscaffold/compare/v4.5...v4.6
Modify Cirrus CI template to save resources, 735
Update Cirrus CI configuration, 752
Update Gitlab CI template, 756
Prefer importlib.resources.files instead of importlib.resources.read_text or pkgutil.get_data, 747
Update version caps for dependency on platformdirs, 755
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Change macOS default configuration dir from ~/Library/Preferences to ~/Library/Application Support, #721. This change is motivated by the upgrade in t
Full Changelog: https://github.com/pyscaffold/pyscaffold/compare/v4.4.1...v4.5
Re-use pre-built wheels in CI for upgrade tests in #702
GITHUB_TOKEN variable in GHA template #715Full Changelog: https://github.com/pyscaffold/pyscaffold/compare/v4.4...v4.4.1
Reuse pre-built wheels in CI for upgrade tests in 702
Make security permissions explicit in GHA template 704
Fix GITHUB_TOKEN variable in GHA template 715
Replace deprecated set-output, #688
codespell to pre-commit config, #674venv_install in config file, #680tox 4.0 and 4.1, #689macos instances on Cirrus CI, #690set-output, #688sdist in tox.ini and FAQ, #694Full Changelog: https://github.com/pyscaffold/pyscaffold/compare/v4.3.1...v4.4
Modify tox.ini template to allow passing the TWINE_REPOSITORY_URL environment variable, https://github.com/pyscaffold/pyscaffold/pull/666
tox.ini template to allow passing the TWINE_REPOSITORY_URL environment variable, https://github.com/pyscaffold/pyscaffold/pull/666Full Changelog: https://github.com/pyscaffold/pyscaffold/compare/v4.3...v4.3.1
This is a small incremental release, focusing on small improvements of existing functionality.
This is a small incremental release, focusing on small improvements of existing functionality.
pyproject.toml (it is redundant since setuptools already includes it), #652.freebsd configuration in .cirrus.yml (with workaround for pipx in 2022Q3 repo), #657.Full Changelog: https://github.com/pyscaffold/pyscaffold/compare/v4.2.3...v4.3
Fix github action creating the demo-repo by, https://github.com/pyscaffold/pyscaffold/pull/644
Full Diff: https://github.com/pyscaffold/pyscaffold/compare/v4.2.2...v4.2.3
I am happy to announce the new patch-level release: PyScaffold v4.2.2.
I am happy to announce the new patch-level release: PyScaffold v4.2.2.
.github/workflows/ci.yml template, https://github.com/pyscaffold/pyscaffold/pull/637, https://github.com/pyscaffold/pyscaffold/pull/640Full Diff: https://github.com/pyscaffold/pyscaffold/compare/v4.2.1...v4.2.2
Update .github/workflows/ci.yml template, 637 and 640
Update note in skeleton.py template clarifying file can be renamed, 641
I am happy to announce the new patch-level release: PyScaffold v4.2.1.
I am happy to announce the new patch-level release: PyScaffold v4.2.1.
This release improves the GitLab CI configuration updated in v4.2.
.gitlab-ci.yml template to work for GitLab Enterprise 14.7.4, #630Full Diff: https://github.com/pyscaffold/pyscaffold/compare/v4.2...v4.2.1
Ensure .gitlab-ci.yml template works for GitLab Enterprise 14.7.4, 630
I am happy to announce the new release: PyScaffold v4.2.
I am happy to announce the new release: PyScaffold v4.2.
This release brings a lot of improvements, specially in terms of continuous integrations! The existing templates for Cirrus CI and GitLab CI were updated and PyScaffold can now generate configurations for GitHub Actions.
--github-actions extension, https://github.com/pyscaffold/pyscaffold/pull/619--gitlab extension, https://github.com/pyscaffold/pyscaffold/pull/622--cirrus extension, https://github.com/pyscaffold/pyscaffold/pull/625tox -e publish example in docs by @bernhardschaefer, https://github.com/pyscaffold/pyscaffold/pull/627colorama as a runtime dependency for windows, #624Full Diff: https://github.com/pyscaffold/pyscaffold/compare/v4.1.5...v4.2
Added --github-actions extension, 619
Updated and improved --gitlab extension, 622
Updated and improved --cirrus extension, 625
Fixed tox -e publish example in docs, 627
Added colorama as a runtime dependency for Windows, 624
I am happy to announce the new release: PyScaffold v4.1.5.
I am happy to announce the new release: PyScaffold v4.1.5.
.python-version into .gitignore, https://github.com/pyscaffold/pyscaffold/pull/576appdirs dependency with platformdirs, https://github.com/pyscaffold/pyscaffold/pull/584python -m setuptools_scm as a form of debugging, https://github.com/pyscaffold/pyscaffold/pull/574pyscaffold/default.cfg, https://github.com/pyscaffold/pyscaffold/pull/580Full Diff: https://github.com/pyscaffold/pyscaffold/compare/v4.1.4...v4.1.5
Added .python-version created by pyenv to .gitignore
Added more --very-verbose logging to make clearer what's going on, 562
Replace internal dependency on appdirs with platformdirs, 584
Fix coverage config for namespaced packages, 610
I am happy to announce the new bugfix release: PyScaffold v4.1.4.
I am happy to announce the new bugfix release: PyScaffold v4.1.4.
Full Changelog: https://github.com/pyscaffold/pyscaffold/compare/v4.1.3...v4.1.4
I am happy to announce the new bugfix release: PyScaffold v4.1.3.
I am happy to announce the new bugfix release: PyScaffold v4.1.3.
The unauthenticated git protocol on port 9418 is no longer supported in https://github.com/pyscaffold/pyscaffold/pull/566Fix pre-commit error: The unauthenticated git protocol on port 9418 is no longer supported, 565
Note
PyScaffold 4.1 is the last release to support Python 3.6
I am happy to announce the new bugfix release: PyScaffold v4.1.2.
I am happy to announce the new bugfix release: PyScaffold v4.1.2.
Full Changelog: https://github.com/pyscaffold/pyscaffold/compare/v4.1.1...v4.1.2
Added verification to prevent users from creating projects nested inside existing repositories, unless --force is explicitly given, 544, 545.
Fixed problem with Windows Shell when running git, 560.
I am happy to announce the release of a new patch version: PyScaffold v4.1.1. This version solves bugs #506 and #516, and the main changes are:
I am happy to announce the release of a new patch version: PyScaffold v4.1.1. This version solves bugs #506 and #516, and the main changes are:
None values (#510).Ensure required extensions are installed on --update, 512
Prevent extension from crashing when persisting None in setup.cfg, 510
Prevent multi-line descriptions to crash putup, 509
Warn users about empty namespaces, 508
Prevent parsing errors during dependency deduplication, 518
Add license_files to setup.cfg template, 524
Adds a partial fixes for issue #516. For the time being comments without indentation inside multiline options (very unlikely) are not handled due to C
Adds a partial fixes for issue #516.
For the time being comments without indentation inside multiline options (very unlikely) are not handled due to ConfigUpdater limitations.
This is a bug fix related to #506.
This is a bug fix related to #506.
I am happy to announce the release of a new minor update: PyScaffold v4.1. The most notable changes are:
I am happy to announce the release of a new minor update: PyScaffold v4.1. The most notable changes are:
linkcheck task for tox.ini, #4560BSD license template.CONTRIBUTING.rst template, #376Added linkcheck task to tox.ini, 456
Updated configuration for Sphinx and ReadTheDocs, 455
Note that templates and the generated boilerplate code is 0BSD-licensed, 461
Added 0BSD license template
Added CONTRIBUTING.rst template, 376
Added PyScaffold badge to README template, 473
Updated Cirrus CI config and templates, including better coveralls integration, 449
Adopted global isolated_build for tox configuration, 483, 491
Loop counter explicitly marked as unused in skeleton.py (flake8-bugbear B007), 495
Ensure update include added extensions in setup.cfg, 496
Minor template updates since 4.1rc2 (#497, #498).
Minor template updates since 4.1rc2 (#497, #498).
Nothing published for this version
v4.1 will bring several improvements specially regarding CI automated tasks configuration and documentation.
v4.1 will bring several improvements specially regarding CI automated tasks configuration and documentation.
Fix WSL2 installation problem, issue 440
440430The most notable changes in this patch-level release are:
The most notable changes in this patch-level release are:
setuptools regarding kebab-cased-keys in setup.cfgsetuptools (fix #428)build when running on conda environments.Fix tox -e build issue when running on Conda, 417
Ensure snake_case for keys in setup.cfg, 418
Update dependencies on configupdater and pyscaffoldext-django
Remove broken checks for old setuptools, 428
This RC adds several improvements for running/building pyscaffold and extensions via conda (thanks to @maresb involvement) and fixes setuptools warnin
This RC adds several improvements for running/building pyscaffold and extensions via conda (thanks to @maresb involvement) and fixes setuptools warnings for lower-kebab-case keys on setup.cfg (#418)
Update dependencies (ConfigUpdates, pyscaffoldext-django). The new version of each dependency fix certain edge cases, but not necessarily issues were
Update dependencies (ConfigUpdates, pyscaffoldext-django). The new version of each dependency fix certain edge cases, but not necessarily issues were found with PyScaffold v4 itself.
The release candidate is meant to give people sometime to play around with the changes in ConfigUpdater and report any bugs.
…and `importlib.metadata`) and of course the deprecation of Python version 2. Moreover, having Python 3.6 as the lowest version officially supported by…
It has been a long journey since PyScaffold v3 was released and a lot of things happened in the Python community especially regarding the packaging ecosystem...
We saw emerging a huge effort to standardise the build process and metadata with PEP 517 and PEP 518, a tendency to avoid pkg_resources (in favour of native namespaces with PEP 420, importlib.resources and importlib.metadata) and of course the deprecation of Python version 2. Moreover, having Python 3.6 as the lowest version officially supported by Python's core team, changed the way developers write their code: a bunch of new features are now available, allowing us to be more expressive and succinct (don't tell me you don't like to use f-strings).
As a result, the PyScaffold team decided to expand our previous ideas for improvements and also incorporate these changes within the ecosystem into a new, super cool, version of PyScaffold. So here I am, proud to officially announce the final release of PyScaffold v4 - now available in PyPI 🥳🎉
The complete list of changes introduced in this version is available at the official website together with a more detailed description of all the features, but I will try to summarise below some highlights of this release.
As a response to PEP 517 and PEP 518, PyScaffold v4 will automatically generate a pyproject.toml in the root of your repository. As a consequence, most of the tools in Python's build ecosystem will assume the distribution should be built in isolation (think of it as creating a virtual environment just for running python setup.py). In general, this change should reduce the chances of things going wrong and improve reproducibility, but it can also mean that you need to adapt a little bit your workflow.
To ease this transition, we are including by default a tox.ini in the root of your project, pre-configured with a lot of common tasks. If you have tox installed in your machine, you will be able to run:
tox -e docs # to build your documentation
tox -e build # to build your package distribution
tox -e publish # to test your project uploads correctly in test.pypi.org
tox -e publish -- --repository pypi # to release your package to PyPI
tox -av # to list all the tasks available
This is meant to be a replacement for deprecated setup.py commands such as:
python setup.py docs
python setup.py tests
# etc ...
We also are recommending using pip install . and pip install -e . instead of python setup.py install and python setup.py develop. In the future, it is very likely that running setup.py directly will be deprecated by setuptools, so we might as well start to get used to an interface that is unlikely to change.
Have you ever tried to use a CLI tool for the first time, or after a long period without using it, and faced a situation that forced you to go back and forth between typing your command and reading the --help text? It is usually not a great experience, especially when you have many options...
A few programs try to solve this problem by providing something called "interactive mode", which, most of the time, corresponds to a bunch of questions being prompted at the terminal. While this method is fine and familiar for most developers, it can get very tiring if the tool asks you more than 7 questions... and choosing by accident the wrong option in the last question, well, then you are going to hate having to reply to the same questions all over again...
Thus, we are trying something different in v4. When you activate the interactive mode with the -i or --interactive flags, PyScaffold will open your favourite text editor (the one you specify with the EDITOR environment variable), with an "editable version" of the --help text. A bit unusual right? But don't worry, it works very similarly to interactive rebases with git, i.e. you can comment options out by preceding the line with an # symbol, edit the values for the options (as shown in the example below), save and close the file then just wait for PyScaffold to run. This is how it looks:
myproject
# path where to generate/update project
# --name myproject
# (or alternatively: -n)
# installable name (as in `pip install`/PyPI, default: basename of
# PROJECT_PATH)
# --package myproject
# (or alternatively: -p)
# package name (as in `import`, default: NAME)
--description 'Add a short description here!'
# (or alternatively: -d)
# package description
# etc ...
One of the nice things about PyScaffold is that you can mix and match many tools according to your workflow. For example, if you like to run some quick tasks like linting or formatting the code before committing your changes, just add --pre-commit when generating your project with putup and PyScaffold will configure your project to use pre-commit.
In v4, we took that to a new level. Now you can dynamically update your project to include the supported tools, so you can gradually evolve and adapt your workflow.
Consider, for example, you have a project generated by PyScaffold, if at any point you decide to start testing it in Cirrus CI, just cd into your project root folder and run:
putup . --update --cirrus
We all have favourites, right? And I guess after a while using PyScaffold you might tend to repeat a series of flags to express your preferences (like --pre-commit, --licence GPL-3.0, etc...). With v4 you can avoid retyping those options by saving a default configuration.
For example, if you create a new project by running:
putup myproject --pre-commit --cirrus --licence GPL-3.0 --save-config
The next time you create a project with putup, the --pre-commit, --cirrus and --licence GPL-3.0 options will be automatically applied, without the need of typing it again.
We hope PyScaffold users will find v4 easier to work with. We also invite everyone to have a look at the official extensions in our GitHub organisation, and if you are a bit more courageous, to have a look at our extensions guide.
In this release we offer a packaging experience up to date with the latest best practices and standardisation in the Python ecosystem, while maintaining the best backward compatibility possible. That is the spirit we plan to bring forward in the next releases.
I hope you all stay productive and have fun! 😉
Anderson Bravalheri & Florian Wilhelm
PyScaffold is the tool of choice for bootstrapping high quality Python packages, ready to be shared on PyPI and installable via pip. It is easy to use and encourages the adoption of the best tools and practices of the Python ecosystem, helping you and your team to stay sane, happy, and productive. The best part? It is stable and has been used by thousands of developers for over half a decade!
PyScaffold was created in 2014 and therefore is stable and battle tested, but yet constantly evolving to support its users' needs and the latest standards of the Python community.
With PyScaffold you can jump start your Python development with an incredibly smart project template, perfected throughout years of serious usage, that promotes the best practices in the Python ecosystem and ships with ready-to-use configuration for all the tools needed by the vast majority of Python developers.
If you are still not convinced, have a look on these other reasons and the extensive list of PyScaffold's features. And if you are curious, checkout our demo project, or install PyScaffold and type putup -h to get started.
Cookiecutter, Django and Travis extensions extracted to their own repositories, 175 and 355
Support for Python 3.4 and 3.5 dropped, 226
Dropped deprecated requirements.txt file, 182
Added support for global configuration (avoid retyping common putup's options), 236
PyScaffold is no longer a build-time dependency, it just generates the project structure
Removed contrib subpackage, vendorized packages are now runtime dependencies, 290
setuptools_scm is included by default in setup.cfg, setup.py and pyproject.toml
API changed to use pyscaffold.operations instead of integer flags, 271
Allow string.Template and callable as file contents in project structure, 295
Extract file system functions from utils.py into file_system.py
Extract identification/naming functions from utils.py into identification.py
Extract action related functions from api/__init__.py to actions.py
helpers.{modify,ensure,reject} moved to structure.py
helpers.{register,unregister} moved to actions.py
New extension for automatically creating virtual environments (--venv)
Added instructions to use pip-tools to docs
pre-commit extension now attempts to install hooks automatically
A nice message is now displayed when PyScaffold finishes running (actions.report_done)
Removed mutually exclusive argparse groups for extensions, 315
Progressive type annotations adopted in the code base together with mypy linting
Simplified isort config
pyproject.toml and isolated builds adopted by default, 256
Added comment to setup.cfg template instructing about extra links, 268
Generate tox.ini by default, 296
Replace pkg_resources with importlib.{metadata,resources} and packaging, 309
Adopt PEP 420 for namespaces, 218
Adopt SPDX identifiers for the license field in setup.cfg, 319
Removed deprecated log.configure_logger
Add links to issues and pull requests to changelog, 363
Add an experimental --interactive mode (inspired by git rebase -i), 191 (additional discussion: 333, 325, 362)
Reorganise the FAQ (including version questions previously in Features)
Updated setuptools and setuptools_scm dependencies to minimal versions 46.1 and 5, respectively
Adopted no-guess-dev version scheme from setuptools_scm (semantically all stays the same, but non-tag commits are now versioned LAST_TAG.post1.devN instead of LAST_TAG.post0.devN)
Fix problem of not showing detailed log with --verbose if error happens when loading extensions 378
This version incorporates some feedback from users, fixes small bugs, and updates in documentation since since v4.0rc1
This version incorporates some feedback from users, fixes small bugs, and updates in documentation since since v4.0rc1
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
*deprecated* setuptools extensions/commands python setup.py test/docs/doctests, 245
Code base changed to Black's standards
New docs about version numbers and git integration
Updated pre-commit hooks
Updated docs/Makefile to use Sphinx "make mode"
deprecated setuptools extensions/commands python setup.py test/docs/doctests, 245
New tox test environments for generating docs and running doctests
New built-in extension for Cirrus CI, 251
experimental get_template is now part of the public API and can be used by extensions, 252
Updated setuptools_scm to version 4.1.2 in contrib
Updated configupdater to version 1.1.2 in contrib
precommit automatically fixes line endings by default
deprecated log.configure_logger, use log.logger.reconfigure instead
Note
PyScaffold 3.3 is the last release to support Python 3.5
Nothing published for this version
Nothing published for this version
Nothing published for this version
Updated configupdater to version 1.0.1
Updated configupdater to version 1.0.1
Changed Travis to Cirrus CI
Fix some problems with Windows
Write files as UTF-8, fixes codec can't encode characters error
Write files as UTF-8, fixes codec can't encode characters error
Nothing published for this version
Updated pre-commit configuration and set max-line-length to 88 (Black's default)
Updated pre-commit configuration and set max-line-length to 88 (Black's default)
Change build folder of Sphinx's Makefile
Fix creation of empty files which were just ignored before
*deprecated* use of lists with helpers.{modify,ensure,reject}, 211
deprecated use of lists with helpers.{modify,ensure,reject}, 211
Add support for os.PathLike objects in helpers.{modify,ensure,reject}, 211
Remove release alias in setup.cfg, use twine instead
Set project-urls and long-description-content-type in setup.cfg, 216
Added additional command line argument very-verbose
Assure clean workspace when updating existing project, 190
Show stacktrace on errors if --very-verbose is used
Updated configupdater to version 1.0
Use pkg_resources.resource_string instead of pkgutil.get_data for templates
Update setuptools_scm to version 3.3.3
Updated pytest-runner to version 5.1
Some fixes regarding the order of executing extensions
Consider GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL environment variables
Updated tox.ini
Switch to using tox in .travis.yml template
Reworked all official extensions --pyproject, --custom-extension and --markdown
Nothing published for this version
Nothing published for this version
*deprecated* built-in Cookiecutter and Django extensions (to be moved to separated packages), 175
Officially dropped Python 2 support, 177
Moved entry_points and setup_requires to setup.cfg, 176
Updated travis.yml template, 181
Set install_requires to setuptools>=31
Better isolation of unit tests, 119
Updated tox template, issues 160 & 161
Use pkg_resources.parse_version instead of old LooseVersion for parsing
Use ConfigUpdater instead of ConfigParser
Lots of internal cleanups and improvements
Updated pytest-runner to version 4.2
Updated setuptools_scm to version 3.1
Fix Django extension problem with src-layout, 196
experimental extension for MarkDown usage in README, 163
experimental support for Pipenv, 140
deprecated built-in Cookiecutter and Django extensions (to be moved to separated packages), 175
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Set install_requires to setuptools>=30.3.0
Set install_requires to setuptools>=30.3.0
Updated setuptools_scm to version 1.17.0
Updated setuptools_scm to version 1.17.0
Fix wrong docstring in skeleton.py about entry_points, 147
Fix error with setuptools version 39.0 and above, 148
Fixes in documentation, thanks Vicky
Nothing published for this version
Nothing published for this version
Fix confusing error message when python setup.py docs and Sphinx is not installed, 142
Fix confusing error message when python setup.py docs and Sphinx is not installed, 142
Fix 'unknown' version in case project name differs from the package name, 141
Fix missing file: attribute in long-description of setup.cfg
Fix sphinx-apidoc invocation problem with Sphinx 1.7
Nothing published for this version
Nothing published for this version
Improved Python API thanks to an extension system
Improved Python API thanks to an extension system
Dropped pbr in favor of setuptools >= 30.3.0
Updated setuptools_scm to v1.15.6
Changed my_project/my_package to recommended my_project/src/my_package structure
Renamed CHANGES.rst to more standard CHANGELOG.rst
Added platforms parameter in setup.cfg
Call Sphinx api-doc from conf.py, 98
Included six 1.11.0 as contrib sub-package
Added CONTRIBUTING.rst
Removed test-requirements.txt from template
Added support for GitLab
License change from New BSD to MIT
FIX: Support of git submodules, 98
Support of Cython extensions, 48
Removed redundant --with- from most command line flags
Prefix n was removed from the local_version string of dirty versions
Added a --pretend flag for easier development of extensions
Added a --verbose flag for more output what PyScaffold is doing
Use pytest-runner 4.4 as contrib package
Added a --no-skeleton flag to omit the creation of skeleton.py
Save parameters used to create project scaffold in setup.cfg for later updating
A special thanks goes to Anderson Bravalheri for his awesome support and inovex for sponsoring this release.
One column per quarter.