=====================
Initial MVP.
Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
This project uses [*towncrier*](https://towncrier.readthedocs.io/) for keeping the changelog. DO NOT commit any changes to this file.
{% include '_draft_changelog.md' ignore missing %}
<!-- towncrier release notes start -->
[1.7.1](https://github.com/pypa/pipx/tree/1.7.1) - 2024-08-23
Bugfixes
- Use minimum supported Python to build zipapp in release action such that `tomli` is included in it. ([1514](https://github.com/pypa/pipx/issues/1514))
[1.7.0](https://github.com/pypa/pipx/tree/1.7.0) - 2024-08-22
Features
- Add a `--prepend` option to the `pipx ensurepath` command to allow prepending `pipx`'s location to `PATH` rather than appending to it. This is useful when you want to prioritize `pipx`'s executables over other executables in your `PATH`. ([1451](https://github.com/pypa/pipx/issues/1451))
- List `PIPX_GLOBAL_[HOME|BIN_DIR|MAN_DIR]` in `pipx environment`. ([1492](https://github.com/pypa/pipx/issues/1492))
Bugfixes
- Introduce `PIPX_HOME_ALLOW_SPACE` environment variable, to silence the spaces in pipx home path warning ([1320](https://github.com/pypa/pipx/issues/1320))
- Fix passing constraints file path into `pipx install` operation via `pip` args ([1389](https://github.com/pypa/pipx/issues/1389))
- Add help messages for `pipx pin` and `pipx unpin` commands. ([1438](https://github.com/pypa/pipx/issues/1438))
- Stop `pipx install --global` from installing files in `~/.local`. ([1475](https://github.com/pypa/pipx/issues/1475))
- Fix installation abortion on multiple packages when one or more are already installed. ([1509](https://github.com/pypa/pipx/issues/1509))
Improved Documentation
- Move all documentation files to the `docs` directory. ([1479](https://github.com/pypa/pipx/issues/1479))
[1.6.0](https://github.com/pypa/pipx/tree/1.6.0) - 2024-06-01
Features
- Add `install-all` command to install packages according to spec metadata file. ([687](https://github.com/pypa/pipx/issues/687))
- Introduce `pipx pin` and `pipx unpin` commands, which can be used to pin or unpin the version
of an installed package, so it will not be upgraded by `pipx upgrade` or `pipx upgrade-all`. ([891](https://github.com/pypa/pipx/issues/891))
- Add a new option `--pinned` to `pipx list` command for listing pinned packages only. ([891](https://github.com/pypa/pipx/issues/891))
- Add `pipx interpreter upgrade` command to upgrade local standalone python in micro/patch level ([1249](https://github.com/pypa/pipx/issues/1249))
- Add `--requirement` option to `inject` command to read list of packages from a text file. ([1252](https://github.com/pypa/pipx/issues/1252))
- Add `pipx upgrade-shared` command, to create/upgrade shared libraries as a standalone command. ([1316](https://github.com/pypa/pipx/issues/1316))
- Allow `upgrade` command to accept multiple packages as arguments. ([1336](https://github.com/pypa/pipx/issues/1336))
- Support Python version for `--python` arg when py launcher is not available ([1342](https://github.com/pypa/pipx/issues/1342))
- Make `install-all` gather errors in batch ([1348](https://github.com/pypa/pipx/issues/1348))
Bugfixes
- Resolve the `DEFAULT_PYTHON` to the actual absolute path ([965](https://github.com/pypa/pipx/issues/965))
- Fix error log overwrite for "-all" batch operations. ([1132](https://github.com/pypa/pipx/issues/1132))
- Do not reinstall already injected packages without `--force` being passed. ([1300](https://github.com/pypa/pipx/issues/1300))
- Only show `--python` and `--force` flag warning if both flags are present ([1304](https://github.com/pypa/pipx/issues/1304))
- Don't allow paths to be passed into `pipx reinstall`, as this might wreak havoc. ([1324](https://github.com/pypa/pipx/issues/1324))
- Make the Python `venv` module arguments work with `upgrade --install` ([1344](https://github.com/pypa/pipx/issues/1344))
- Fix version check for standalone python ([1349](https://github.com/pypa/pipx/issues/1349))
- Validate package(s) argument should not be path(s). ([1354](https://github.com/pypa/pipx/issues/1354))
- Validate whether a package is an URL correctly. ([1355](https://github.com/pypa/pipx/issues/1355))
- Support python3.8 for standalone python builds ([1375](https://github.com/pypa/pipx/issues/1375))
- Install specified version of `--preinstall` dependency instead of latest version ([1377](https://github.com/pypa/pipx/issues/1377))
- Move `--global` option into shared parser, such that it can be passed after the subcommand, for example `pipx ensurepath --global`. ([1397](https://github.com/pypa/pipx/issues/1397))
- Fix discovery of a `pipx run` entry point if a local path was given as package. ([1422](https://github.com/pypa/pipx/issues/1422))
Improved Documentation
- Create a dedicated section for manual pages and add an example with `pdm-backend`. ([1312](https://github.com/pypa/pipx/issues/1312))
- Add example, test and cli help description how to install multiple packages with the --preinstall flag ([1321](https://github.com/pypa/pipx/issues/1321))
- Refine docs generation script and template. ([1325](https://github.com/pypa/pipx/issues/1325))
- Add a note about sourcing the shell config file for `ensure_path` ([1346](https://github.com/pypa/pipx/issues/1346))
[1.5.0](https://github.com/pypa/pipx/tree/1.5.0) - 2024-03-29
Features
- Add `--global` option to `pipx` commands.
- This will run the action in a global scope and affect environment for all system users. ([754](https://github.com/pypa/pipx/issues/754))
- Add a `--fetch-missing-python` flag to all commands that accept a `--python` flag.
- When combined, this will automatically download a standalone copy of the requested python version if it's not already available on the user's system. ([1242](https://github.com/pypa/pipx/issues/1242))
- Add commands to list and prune standalone interpreters ([1248](https://github.com/pypa/pipx/issues/1248))
- Revert platform-specific directories on MacOS and Windows
- They were leading to a lot of issues with Windows sandboxing and spaces in shebangs on MacOS. ([1257](https://github.com/pypa/pipx/issues/1257))
- Add `--install` option to `pipx upgrade` command.
- This will install the package given as argument if it is not already installed. ([1262](https://github.com/pypa/pipx/issues/1262))
Bugfixes
- Correctly resolve home directory in pipx directory environment variables. ([94](https://github.com/pypa/pipx/issues/94))
- Pass through `pip` arguments when upgrading shared libraries. ([964](https://github.com/pypa/pipx/issues/964))
- Fix installation issues when files in the working directory interfere with venv creation process. ([1091](https://github.com/pypa/pipx/issues/1091))
- Report correct filename in tracebacks with `pipx run <scriptname>` ([1191](https://github.com/pypa/pipx/issues/1191))
- Let self-managed pipx uninstall itself on windows again. ([1203](https://github.com/pypa/pipx/issues/1203))
- Fix path resolution for python executables looked up in PATH on windows. ([1205](https://github.com/pypa/pipx/issues/1205))
- Display help message when `pipx install` is run without arguments. ([1266](https://github.com/pypa/pipx/issues/1266))
- Fix crashes due to superfluous `-q ` flags by discarding exceeding values ([1283](https://github.com/pypa/pipx/issues/1283))
Improved Documentation
- Update the completion instructions for zipapp users. ([1072](https://github.com/pypa/pipx/issues/1072))
- Update the example for running scripts with dependencies. ([1227](https://github.com/pypa/pipx/issues/1227))
- Update the docs for package developers on the use of configuration using pyproject.toml ([1229](https://github.com/pypa/pipx/issues/1229))
- Add installation instructions for Fedora ([1239](https://github.com/pypa/pipx/issues/1239))
- Update the examples for installation from local dir ([1277](https://github.com/pypa/pipx/issues/1277))
- Fix inconsistent wording in `pipx install` command description. ([1307](https://github.com/pypa/pipx/issues/1307))
Deprecations and Removals
- Deprecate `--skip-maintenance` flag of `pipx list`; maintenance is now never executed there ([1256](https://github.com/pypa/pipx/issues/1256))
Misc
- [1296](https://github.com/pypa/pipx/issues/1296)
[1.4.3](https://github.com/pypa/pipx/tree/1.4.3) - 2024-01-16
Bugfixes
- Autofix python version for pylauncher, when version is provided prefixed with `python` ([1150](https://github.com/pypa/pipx/issues/1150))
- Support building pipx wheels with setuptools-scm<7, such as on FreeBSD. ([1208](https://github.com/pypa/pipx/issues/1208))
Improved Documentation
- Provide useful error messages when unresolvable python version is passed ([1150](https://github.com/pypa/pipx/issues/1150))
- Introduce towncrier for managing the changelog ([1161](https://github.com/pypa/pipx/issues/1161))
- Add workaround for using pipx applications in shebang under macOS ([1198](https://github.com/pypa/pipx/issues/1198))