History¶

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Hatch¶

Unreleased¶

1.4.0 - 2022-08-06¶

Added:

• The default Python for virtual environments now checks PATH before using the one Hatch is running on
• Values for environment env-vars now support context formatting
• Add name override for environments to allow for regular expression matching
• The index publisher now better supports non-PyPI indices
• Add certificate options to the index publisher
• Display waiting text when checking dependencies and removing environments
• Display help text the first time the shell command is executed
• Update project templates with Python 3.11 and the latest versions of various GitHub Actions
• Add support for Almquist (ash) shells
• Add hyperlink as a dependency for better handling of package index URLs
• Bump the minimum supported version of virtualenv to 20.16.2
• Bump the minimum supported version of tomlkit to 0.11.1

Fixed:

• Acknowledge extra-dependencies for the env show command
• Fix locating executables within virtual environments on Debian
• Fix managing the terminal size inside the shell command
• Fix default code coverage file omission for the src-layout project template option

1.3.1 - 2022-07-11¶

Fixed:

• Support -h/--help flag for the run command

1.3.0 - 2022-07-10¶

Changed:

• Rename the default publishing plugin from pypi to the more generic index

Added:

• Support the absence of pyproject.toml files, as is the case for apps and non-Python projects
• Hide scripts that start with an underscore for the env show command by default
• Ignoring the exit codes of commands by prefixing with hyphens now works with entire named scripts
• Add a way to require confirmation for publishing
• Add --force-continue flag to the env run command
• Make tracebacks colorful and less verbose
• When shell configuration has not been defined, attempt to use the current shell based on parent processes before resorting to the defaults
• The shell name pwsh is now an alias for powershell
• Remove atomicwrites dependency
• Relax constraint on userpath dependency
• Bump the minimum supported version of Hatchling to 1.4.1

Fixed:

• Keep environments in sync with the dependencies of the selected features
• Use utf-8 for all files generated for new projects
• Escape special characters Git may return in the user name when writing generated files for new projects
• Normalize the package name to lowercase in setuptools migration script
• Fix parsing of source distributions during publishing

1.2.1 - 2022-05-30¶

Fixed:

• Fix handling of top level data_files in setuptools migration script

1.2.0 - 2022-05-22¶

Changed:

• The enter_shell environment plugin method now accepts an additional args parameter

Added:

• Allow context string formatting for environment dependencies
• Add environment context string formatting fields env_name, env_type, matrix, verbosity, and args
• Support overriding the default arguments used to spawn shells on non-Windows systems
• Bump the minimum supported version of Hatchling to 1.3.0

Fixed:

• Improve setuptools migration script

1.1.2 - 2022-05-20¶

Fixed:

• Bump the minimum supported version of Hatchling to 1.2.0
• Update project metadata to reflect support for Python 3.11

1.1.1 - 2022-05-12¶

Fixed:

• Fix setuptools migration script for non-Windows systems

1.1.0 - 2022-05-12¶

Changed:

• In order to simplify the implementation of command execution for environment plugins, the run_shell_commands method has been replaced by the singular run_shell_command. A new command_context method has been added to more easily satisfy complex use cases.
• The finalize_command environment plugin method has been removed in favor of the newly introduced context formatting functionality.

Added:

• Add context formatting functionality i.e. the ability to insert values into configuration like environment variables and command line arguments
• Any verbosity for command execution will now always display headers, even for single environments
• Every executed command is now displayed when running multiple commands or when verbosity is enabled
• Similar to make, ignore the exit code of executed commands that start with - (a hyphen)
• Add ability for the --init flag of the new command to automatically migrate setuptools configuration
• Update project metadata to reflect the adoption by PyPA and production stability

1.0.0 - 2022-04-28¶

This is the first stable release of Hatch v1, a complete rewrite. Enjoy!

Hatchling¶

Unreleased¶

1.7.0 - 2022-08-12¶

Added:

• Add require-runtime-features option for builders and build hooks
• Check for unknown trove classifiers
• Update SPDX license information to version 3.18

Fixed:

• Add better error message for wheel target dev mode installations that define path rewrites with the sources option
• Note the allow-direct-references option in the relevant error messages

1.6.0 - 2022-07-23¶

Changed:

• When no build targets are specified on the command line, now default to sdist and wheel targets rather than what happens to be defined in config
• The code version source now only supports files with known extensions
• Global build hooks now run before target-specific build hooks to better match expected behavior

Added:

• The code version source now supports loading extension modules
• Add search-paths option for the code version source

Fixed:

• Fix removing sources using an empty string value in the mapping
• The strict-naming option now also applies to the metadata directory of wheel targets

1.5.0 - 2022-07-11¶

Added:

• Support the final draft of PEP 639
• Add strict-naming option for sdist and wheel targets

Fixed:

• Project names are now stored in sdist and wheel target core metadata exactly as defined in pyproject.toml without normalization to allow control of how PyPI displays them

1.4.1 - 2022-07-04¶

Fixed:

• Fix forced inclusion of important files like licenses for sdist targets when using the explicit selection options
• Don't sort project URL metadata so that the rendered order on PyPI can be controlled

1.4.0 - 2022-07-03¶

Changed:

• The packages option uses the new only-include option to provide targeted inclusion, since that is desired most of the time. You can retain the old behavior by using the include and sources options together.

Added:

• Support PEP 561 type hinting
• Add version build hook
• Add only-include option
• The editable version of wheel targets now respects the force-include option by default
• The force-include option now supports path rewriting with the sources option
• The wheel target shared-data and extra-metadata options now respect file selection options
• The wheel target now auto-detects single module layouts
• Improve performance by never entering directories that are guaranteed to be undesirable like __pycache__ rather than excluding individual files within
• Update SPDX license information to version 3.17

Fixed:

• Don't write empty entry points file for wheel targets if there are no entry points defined
• Allow metadata hooks to set the version in all cases
• Prevent duplicate file entries from inclusion when using the force-include option

1.3.1 - 2022-05-30¶

Fixed:

• Better populate global variables for the code version source

1.3.0 - 2022-05-22¶

Removed:

• Remove unused global args context string formatting field

Added:

• Improve error messages for the env context string formatting field

Fixed:

• Fix uri context string formatting modifier on Windows

1.2.0 - 2022-05-20¶

Added:

• Allow context formatting for project.dependencies and project.optional-dependencies

1.1.0 - 2022-05-19¶

Added:

• Add uri and real context string formatting modifiers for file system paths

1.0.0 - 2022-05-17¶

Changed:

• Drop support for Python 2

Added:

• Improve error messaging for invalid versions
• Update project metadata to reflect support for Python 3.11

0.25.1 - 2022-06-14¶

Fixed:

• Fix support for Windows on Python 2 by removing its support for symlinks

0.25.0 - 2022-05-15¶

Added:

• Add skip-excluded-dirs build option
• Allow build data to add additional project dependencies for wheel and sdist build targets
• Add force_include_editable build data for the wheel build target
• Add build_hooks build data
• Add support for Mercurial's .hgignore files when using glob syntax
• Update project metadata to reflect the adoption by PyPA

Fixed:

• Properly use underscores for the name of force_include build data
• No longer greedily skip excluded directories by default

0.24.0 - 2022-04-28¶

This is the initial public release of the Hatchling build system. Support for Python 2 will be dropped in version 1.