reference CONTRIBUTING Code of Conduct <CODE_OF_CONDUCT> license Changelog <https://github.com/cjolowicz/poetry-up/releases>
Command-line tool for upgrading Python dependencies using Poetry.
By default, this tool determines outdated dependencies using poetry show --outdated
, and performs the following actions for every reported package:
- Switch to a new branch
poetry-up/<package>-<version>
.- Update the dependency with
poetry update
. For incompatible updates, also updatepyproject.toml
.- Commit the changes to pyproject.toml and poetry.lock.
- Push to origin (optional).
- Open a pull request or merge request (optional).
If no packages are specified on the command-line, all outdated dependencies are upgraded.
To install poetry-up, run this command in your terminal:
$ pip install poetry-up
poetry-up's usage looks like:
$ poetry-up [<options>] [<packages>]
--install
Install dependency into virtual environment. This is the default behavior.
--no-install
Do not install dependency into virtual environment.
--commit
Commit the changes to Git. This is the default behavior.
--no-commit
Do not commit the changes to Git.
--push
Push the changes to the remote repository.
--no-push
Do not push the changes to the remote repository. This is the default behavior.
--merge-request
Open a merge request.
--no-merge-request
Do not open a merge request. This is the default behavior.
--pull-request
Open a pull request.
--no-pull-request
Do not open a pull request. This is the default behavior.
--upstream <branch>, -u <branch>
Specify the upstream branch. By default, branches are created off the master branch.
--remote <remote>, -r <remote>
Specify the remote to push to. By default, branches are pushed to origin.
-C <directory>, --cwd <directory>
Change to this directory before performing any actions.
-n, --dry-run
Just show what would be done.
--version
Display the version and exit.
--help
Display a short usage message and exit.