Wrapper around pip commands to auto-update requirements file
Project description
pipm
Python package management using pip, requirements file & setup.cfg.
Installation
- Adviced to install only inside virtualenv
Install from PyPI
pip install pipm
Note:
- This tool manipulates all your requirements file. So be sure to use version control software or take backup of your files to keep track of changes.
Quickstart
- Both
pipandpipmcommand will work as the same. - Create a virtualenv for the project and install pipm with
pip install pipm
- Create an alias as
alias pip=pipmor use as it is -pipm
I. Install
- install all your dependencies from the base requirements file (
requirements.txt)
pipm install
pipm install --all # *requirements*.txt - all environment -> test/prod/dev
2. Add new packages to project
pipm install pkg-name
pipm install pkg-name --dev # as development dependency
pipm install pkg-name --test # as testing dependency
3. Removal of packages
- Remove one or more packages. Their dependencies will also get uninstalled. No orphaned packages.
pipm uninstall pkg-name
4. update all your dependencies in requirements.txt
pipm update
pipm update --dev
Features
- No new set of files.
*-requirements.txtworks like the lockfile with pinned versions - Just a wrapper around the standard pip's
install/uninstallcommand. So all the cli options will work - Handles multiple
requirementsfiles and setup.cfg stores abstract dependencies.
Commands
1. install
- a wrapper around standard
pip installcommand and accepts all the standard options
Below are the things that pipm brings to the table
- Extra functionality
- when package names are given it will be saved to the requirements.txt file in the current directory.
If you have
requirementsdirectory structure withbase.txtinside then that file will be used. Otherwise it will create one in the current directory. - when no package name is given then it is equivalent to
-r requirements.txtand it will install all requirements from the current directory
- when package names are given it will be saved to the requirements.txt file in the current directory.
If you have
- Additional options:
It will search for the matching one in the following pattern
<name>-requirements.txtorrequirements/<name>.txtorrequirements-<name>.txtthe below saves to file when package name given otherwise equivalent to passing requirements file name.--dev- saves to development requirements--prod- saves to production requirements--test- saves to testing requirements--doc- saves to documentation requirements--env <name>- if you have any special set of requirements that belong to a separate file you could pass the name here.
2. uninstall
- a wrapper around standard
pip uninstallcommand - alias
rmis available - when uninstalling a package, this command also checks packages that are no longer required by any of user installed packages and removes them
- ofcourse it removes the packages from
requirementsfiles
3. update
- new command
- equivalent to calling
pip installwith--upgradeflag - update a single package or the whole environment when no argument given.
- by default the packages are updated interactively
- set
--auto-updateto disable this
- set
4. save/freeze
- extends the standard freeze command to save the currently installed packages
Development
- clone the repository and create new virtualenv
git clone git@github.com:jnoortheen/pipm.git
cd pipm
pew new pipm -a .
pip install -r dev-requirements.txt
- to test from local sources
pip install -e .
- Commit message should follow this style-guide.
Testing
- run
invoke testfrom the root directory.
Alternatives and their problems (IMHO)
- pipenv
- good for local development with only one virtual environment per project
- Not good when we need to deploy over production server or keep multiple virtuals-envs
- it is better to use
pewalone instead of the shell command that comes with this
- pip-tools
- another set of files to keep track of, additional commands to remember
- poetry
- more robust than
pipenv - ~~the problems I faced are related to installing dependencies in remote servers/docker environments. ~~
longer install/update times~~As the project matures this problem might get resolved. ~~- since version 1.1 these are solved.
- new projects are to advised to use poetry when possible.
- more robust than
- dephell
- haven't used it. But seems to handle requirements files as well as other formats.
TODOs:
- rm will check whether a package is present in setup.cfg
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pipm-22.2.3.tar.gz
(11.9 kB
view details)
Built Distribution
pipm-22.2.3-py3-none-any.whl
(13.9 kB
view details)
File details
Details for the file pipm-22.2.3.tar.gz.
File metadata
- Download URL: pipm-22.2.3.tar.gz
- Upload date:
- Size: 11.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/28.0 requests/2.25.0 requests-toolbelt/0.9.1 urllib3/1.26.5 tqdm/4.53.0 importlib-metadata/4.11.1 keyring/21.5.0 rfc3986/1.4.0 colorama/0.4.4 CPython/3.8.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6e974d67d410b56403fa70a8a14c3a9ef9f458f9fb977ef5112d74b625beda43 |
|
| MD5 | 3beb18f9e1869dc54f2866ad9d542063 |
|
| BLAKE2b-256 | 26c4a0fb06eb27d5768fa5ea09507315dd6f7c788835729ebc2bd882b4210618 |
File details
Details for the file pipm-22.2.3-py3-none-any.whl.
File metadata
- Download URL: pipm-22.2.3-py3-none-any.whl
- Upload date:
- Size: 13.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/28.0 requests/2.25.0 requests-toolbelt/0.9.1 urllib3/1.26.5 tqdm/4.53.0 importlib-metadata/4.11.1 keyring/21.5.0 rfc3986/1.4.0 colorama/0.4.4 CPython/3.8.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d354e588d5bed580be1113451ec905d66c1ab572fd4ff9dbfa6040c4f87b11f1 |
|
| MD5 | 9ffeba0770a7220dbd3f0d4d91870952 |
|
| BLAKE2b-256 | 7cd4a9db7d67e0abfdacc7cc53e97e345a53fd2e1be2030ab11583919772627d |
