Wrapper around pip commands to auto-update requirements file
Project description
pipm
Python package management workflow using pip, requirements file & setup.cfg as its metadata. (For the time being and old world of python)
Installation
- Adviced to install only inside virtualenv as this will replace pip executable
Install from PyPI
pip install six
pip install pipm
Or Install directly from the GitHub
pip install -e git://github.com/jnoortheen/pipm.git@master#egg=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 pip and pipm command will work as the same. Create an alias as alias pip=pipm and you are good to go.
install all your dependencies from the requirements file
- to install only from
requirements.txt
pipm install
- to install from all
*requirements*.txt
pipm install --all
installation
pipm install pkg-name or
pip install pkg-name
installation as development dependency
pipm install pkg-name --dev
installation as testing dependency
pipm install pkg-name --test
removal
pipm uninstall pkg-name
update all your dependencies
pipm update
including development dependencies
pipm install --dev
Usage
-
install
- a wrapper around standard
pip installcommand and accepts all the standard options
Below are the things that
pipmbrings 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:
the 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--env <name>- if you have any special set of requirements that belong to a separate file you could pass the name here. It will search for the matching one in the following pattern<name>-requirements.txtorrequirements/<name>.txtorrequirements-<name>.txt
- a wrapper around standard
-
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 the installed packages and removes them
- ofcourse it removes the packages from
requirementsfiles
- a wrapper around standard
-
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
-
save/freeze
- extends the standard freeze command to save the currently installed packages
Features
- Just a wrapper around the standard pip's
install/uninstallcommand. So all the cli options will work - Handles multiple
requirementsfiles - No new set of files. requirements files contain pinned dependecies and setup.cfg contain abstract dependencies.
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 .
Testing
- run
invoke testfrom the root directory.
Version compatibility
the package is versioned in accordance with pip major version number.
pipm-9.* will be compatible with pip-9 and such.
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
- better than pipenv and do not interfere much in environment management with pew
- the problems I faced are related to installing dependencies in remote servers/docker environments. As the project matures this problem might get resolved.
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-10.4.3.tar.gz
(10.9 kB
view hashes)
Built Distribution
pipm-10.4.3-py2.py3-none-any.whl
(26.2 kB
view hashes)
Close
Hashes for pipm-10.4.3-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 67c36b8d9560e95acab810358fb1612952a3c747759b237e28d84c0a1b97442e |
|
| MD5 | 3aba31b62e7d2f8ca4fd8d2597e906ee |
|
| BLAKE2b-256 | eccaa26aed5d6fb32f816a33e038dc56a8bd636f4a35b41b74d964d018a2621b |
