# pip-upgrade 🎉
The purpose of pip-upgrade is to be a simple yet robust and reliable tool for upgrading all of your packages while not breaking dependencies.
## Installation
pip install pip-upgrade-tool
or
pip install git+https://github.com/realiti4/pip-upgrade.git@master --upgrade
## Usage
Just run `pip-upgrade` in your terminal while virtualenv is active.
$ pip-upgrade
```
Checking outdated packages...
These packages will be upgraded: ['colorama', 'isort']
Continue? (y/n): y
...
All packages are up to date! 🎉
```
**Tip:** You can use `-e` to exclude some packages and continue in `Continue? (y/n):` after seeing which packages are going to be upgraded. This is super useful for packages like gohlke's Numpy+mkl for example. `-r` to repeat the previous excluded packages. It'll show if there is a saved repeatable action.
```
These packages will be upgraded: ['hypothesis', 'Pillow', 'pytest', 'setuptools']
(-r, --repeat : -e pytest)
Continue? (y/n or -e/-r/--help): -e pytest hypothesis
```
You can also exclude packages beforehand. Use `-e` or `--exclude`. The tool won't upgrade dependency breaking packages already, this is extra for packages that you want to keep it at a version. You can also add packages to config file for this to persist until you remove. This combined with `pip-upgrade -y` that accepts and skips user prompt can be used for automated environments.
$ pip-upgrade -e numpy pandas
### Options
- `pip-upgrade -e` Exclude packages you don't want to upgrade. Can take multiple or single value.
- `pip-upgrade -y` Accept all upgrades and skip user prompt.
- `pip-upgrade --clean` Clear pip's cache.
- `pip-upgrade --local` By default locally installed editable packages (installed with `pip install -e .`) won't be upgraded. Use this option to upgrade everything.
- `pip-upgrade --novenv` By default the tool won't work if virtualenv is not active. Use this if you want use it globally and pass the assertion error.
- `pip-upgrade --reset-config` Reset config file located in `~/.pipupgrade.ini` to it's default.
### Permanent Configuration
When `pip-upgrade` is run for the first time, it will create a file in the user's home directory named `.pipupgrade.ini`. This file can be manually edited by the user for permanent configuration options. The configuration file current consists of two options under the `conf` section, `exclude` and `novenv`. `novenv` is false by default, but if set to true, the `pip-upgrade` command will not require you to be in a virtualenv, which is the same function as the `--novenv` argument. The second option, `exclude`, will take the same values as the `--exclude` argument, but these excluded packages will persist forever until removed.
### Contributing
Any contribution is appreciated, please feel free to send pull requests.
#### TODO / known issues
- Feature - Update directly from Gohlke's packages
- Feature - Revert to previous point
Raw data
{
"_id": null,
"home_page": "https://github.com/realiti4/pip-upgrade",
"name": "pip-upgrade-tool",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Onur Cetinkol",
"author_email": "realiti44@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b3/98/dce51116aa7f82c5b4fe0c2f25e173071c824deb23b87e3f7bc17984271a/pip-upgrade-tool-0.7.4.tar.gz",
"platform": null,
"description": "# pip-upgrade \ud83c\udf89\nThe purpose of pip-upgrade is to be a simple yet robust and reliable tool for upgrading all of your packages while not breaking dependencies.\n\n## Installation\n\n\tpip install pip-upgrade-tool\n\nor\n\n pip install git+https://github.com/realiti4/pip-upgrade.git@master --upgrade\n\n## Usage\nJust run `pip-upgrade` in your terminal while virtualenv is active.\n\n $ pip-upgrade\n\n```\nChecking outdated packages...\nThese packages will be upgraded: ['colorama', 'isort']\nContinue? (y/n): y\n...\nAll packages are up to date! \ud83c\udf89\n```\n\n**Tip:** You can use `-e` to exclude some packages and continue in `Continue? (y/n):` after seeing which packages are going to be upgraded. This is super useful for packages like gohlke's Numpy+mkl for example. `-r` to repeat the previous excluded packages. It'll show if there is a saved repeatable action.\n```\nThese packages will be upgraded: ['hypothesis', 'Pillow', 'pytest', 'setuptools']\n(-r, --repeat : -e pytest)\nContinue? (y/n or -e/-r/--help): -e pytest hypothesis\n```\n\nYou can also exclude packages beforehand. Use `-e` or `--exclude`. The tool won't upgrade dependency breaking packages already, this is extra for packages that you want to keep it at a version. You can also add packages to config file for this to persist until you remove. This combined with `pip-upgrade -y` that accepts and skips user prompt can be used for automated environments.\n\n $ pip-upgrade -e numpy pandas\n### Options\n- `pip-upgrade -e` Exclude packages you don't want to upgrade. Can take multiple or single value.\n- `pip-upgrade -y` Accept all upgrades and skip user prompt.\n- `pip-upgrade --clean` Clear pip's cache.\n- `pip-upgrade --local`\tBy default locally installed editable packages (installed with `pip install -e .`) won't be upgraded. Use this option to upgrade everything.\n- `pip-upgrade --novenv` By default the tool won't work if virtualenv is not active. Use this if you want use it globally and pass the assertion error.\n- `pip-upgrade --reset-config` Reset config file located in `~/.pipupgrade.ini` to it's default.\n\n### Permanent Configuration\nWhen `pip-upgrade` is run for the first time, it will create a file in the user's home directory named `.pipupgrade.ini`. This file can be manually edited by the user for permanent configuration options. The configuration file current consists of two options under the `conf` section, `exclude` and `novenv`. `novenv` is false by default, but if set to true, the `pip-upgrade` command will not require you to be in a virtualenv, which is the same function as the `--novenv` argument. The second option, `exclude`, will take the same values as the `--exclude` argument, but these excluded packages will persist forever until removed. \n\n### Contributing\nAny contribution is appreciated, please feel free to send pull requests.\n\n#### TODO / known issues\n- Feature - Update directly from Gohlke's packages\n- Feature - Revert to previous point\n",
"bugtrack_url": null,
"license": "",
"summary": "An easy tool for upgrading all of your packages while not breaking dependencies",
"version": "0.7.4",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc95295ef3e1f8eddbdd0baa28fc9bb635a6f45339ccd7a96a79d04bcf72a06c",
"md5": "063b119ae792c2d2661ab7c6556ed80b",
"sha256": "9a9d049c0c0e615906c1ced181bbe05e1f7f011975cc690c3ff76474871be62c"
},
"downloads": -1,
"filename": "pip_upgrade_tool-0.7.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "063b119ae792c2d2661ab7c6556ed80b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 13202,
"upload_time": "2023-01-27T19:29:49",
"upload_time_iso_8601": "2023-01-27T19:29:49.905945Z",
"url": "https://files.pythonhosted.org/packages/dc/95/295ef3e1f8eddbdd0baa28fc9bb635a6f45339ccd7a96a79d04bcf72a06c/pip_upgrade_tool-0.7.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b398dce51116aa7f82c5b4fe0c2f25e173071c824deb23b87e3f7bc17984271a",
"md5": "c6b550440a5782a10e2adf8956f1943c",
"sha256": "40b8ee2d66f9e222fffa594d2ad6b71e4f755e675a25166ad503ef358409ed65"
},
"downloads": -1,
"filename": "pip-upgrade-tool-0.7.4.tar.gz",
"has_sig": false,
"md5_digest": "c6b550440a5782a10e2adf8956f1943c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11283,
"upload_time": "2023-01-27T19:29:51",
"upload_time_iso_8601": "2023-01-27T19:29:51.758104Z",
"url": "https://files.pythonhosted.org/packages/b3/98/dce51116aa7f82c5b4fe0c2f25e173071c824deb23b87e3f7bc17984271a/pip-upgrade-tool-0.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-27 19:29:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "realiti4",
"github_project": "pip-upgrade",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pip-upgrade-tool"
}
JSON
