Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linkedin/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.
https://github.com/linkedin/shiv
Last synced: about 2 months ago
JSON representation
shiv is a command line utility for building fully self contained Python zipapps as outlined in PEP 441, but with all their dependencies included.
- Host: GitHub
- URL: https://github.com/linkedin/shiv
- Owner: linkedin
- License: bsd-2-clause
- Created: 2018-03-13T18:46:23.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-09T22:11:12.000Z (4 months ago)
- Last Synced: 2024-07-18T17:44:59.492Z (2 months ago)
- Language: Python
- Homepage:
- Size: 298 KB
- Stars: 1,711
- Watchers: 26
- Forks: 93
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-python-resources - GitHub - 31% open · ⏱️ 17.08.2022): (分发)
- best-of-python-dev - GitHub - 39% open · ⏱️ 09.05.2024): (Code Packaging)
- starred-awesome - 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. (Python)
README
[](https://pypi.python.org/pypi/shiv)
[](https://github.com/linkedin/shiv/actions?query=workflow%3Aci)
[](https://codecov.io/gh/linkedin/shiv)
[](http://shiv.readthedocs.io/en/latest/?badge=latest)
[](https://opensource.org/licenses/BSD-2-Clause)
[](https://pypi.python.org/pypi/shiv)
# shiv
shiv is a command line utility for building fully self-contained Python zipapps as outlined in [PEP 441](https://www.python.org/dev/peps/pep-0441/), but with all their dependencies included!
shiv's primary goal is making distributing Python applications fast & easy.
📗 Full documentation can be found [here](http://shiv.readthedocs.io/en/latest/).
### sys requirements
- python3.8+
- linux/osx/windows
### quickstart
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 flake8 with shiv:
```sh
$ shiv -c flake8 -o ~/bin/flake8 flake8
$ ~/bin/flake8 --version
3.7.8 (mccabe: 0.6.1, pycodestyle: 2.5.0, pyflakes: 2.1.1) CPython 3.7.4 on Darwin
```
`-c flake8` specifies the console script that should be invoked when the executable runs, `-o ~/bin/flake8` specifies the location of the generated executable file and `flake8` is the dependency that should be installed from PyPI.
Creating an interactive executable with the boto library:
```sh
$ shiv -o boto.pyz boto
Collecting boto
Installing collected packages: boto
Successfully installed boto-2.49.0
$ ./boto.pyz
Python 3.7.4 (v3.7.4:e09359112e, Jul 8 2019, 14:54:52)
[Clang 6.0 (clang-600.0.57)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
(InteractiveConsole)
>>> import boto
>>> boto.__version__
'2.49.0'
```
### installing
You can install shiv by simply downloading a release from https://github.com/linkedin/shiv/releases or via `pip` / `pypi`:
```sh
pip install shiv
```
You can even create a pyz _of_ shiv _using_ shiv!
```sh
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:
```sh
git clone [email protected]:linkedin/shiv.git
cd shiv
python3 -m venv venv
source ./venv/bin/activate
python3 -m pip install --upgrade build
python3 -m build
python3 -m pip install -e .
```
Don't forget to run and write tests:
```sh
python3 -m pip install tox
tox
```
To build documentation when you changed something in `docs`:
```sh
python3 -m pip install -r docs/requirements.txt
sphinx-build docs build/html
```
### 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:
* [PEX](https://github.com/pantsbuild/pex)
* [pyzzer](https://pypi.org/project/pyzzer/#description)
* [superzippy](https://github.com/brownhead/superzippy)
Logo by Juliette Carvalho