A command line utility for building fully self contained Python zipapps.
Project description
shiv
shiv is a command line utility for building fully self-contained Python zipapps as outlined in PEP 441, but with all their dependencies included!
shiv's primary goal is making distributing Python applications fast & easy.
Full documentation can be found here.
sys requirements
- python3.6+
- linux/osx/windows
how to
shiv has a few command line options of its own and accepts almost all options passable to pip install.
simple cli example
Creating an executable of pipenv with shiv:
$ shiv -c pipenv -o ~/bin/pipenv pipenv pew
$ ~/bin/pipenv --version
pipenv, version 2018.05.18
complex example involving a wheel cache
Creating an interactive executable with a downloaded wheel of boto:
$ python3 -m pip download boto Collecting boto File was already downloaded /tmp/tmp.iklsO1qyd3/boto-2.48.0-py2.py3-none-any.whl Successfully downloaded boto $ shiv -o boto.pyz --find-links . --no-index boto shiv! 🔪 Collecting boto Installing collected packages: boto Successfully installed boto-2.48.0 done $ ./boto.pyz Python 3.6.1 (default, Apr 19 2017, 21:58:41) [GCC 4.8.5 20150623 (Red Hat 4.8.5-4)] on linux Type "help", "copyright", "credits" or "license" for more information. (InteractiveConsole) >>> import boto >>>
installing
You can install shiv via pip / pypi
pip install shiv
You can even create a pyz of shiv using shiv!
python3 -m venv .
source bin/activate
pip install shiv
shiv -c shiv -o shiv shiv
developing
We'd love contributions! Getting bootstrapped to develop is easy:
git clone git@github.com:linkedin/shiv.git
cd shiv
python3 setup.py venv
. activate
python3 setup.py develop
Don't forget to run and write tests:
pip install tox tox
gotchas
Zipapps created with shiv are not guaranteed to be cross-compatible with other architectures. For example, a pyz
file built on a Mac may only work on other Macs, likewise for RHEL, etc. This usually only applies to zipapps that have C extensions in their dependencies. If all your dependencies are pure python, then chances are the pyz will work on other platforms. Just something to be aware of.
Zipapps created with shiv will extract themselves into ~/.shiv, unless overridden via
SHIV_ROOT. If you create many utilities with shiv, you may want to occasionally clean this
directory.
acknowledgements
Similar projects:
Logo by Juliette Carvalho
Release history Release notifications
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size shiv-0.0.48-py3-none-any.whl (16.2 kB) | File type Wheel | Python version py3 | Upload date | Hashes View hashes |
| Filename, size shiv-0.0.48.tar.gz (18.7 kB) | File type Source | Python version None | Upload date | Hashes View hashes |
