Metadata-Version: 2.1
Name: shiv
Version: 0.0.46
Summary: A command line utility for building fully self contained Python zipapps.
Home-page: https://github.com/linkedin/shiv
Author: Loren Carvalho
Author-email: lcarvalho@linkedin.com
License: BSD License
Description: [![PyPI](https://img.shields.io/pypi/v/shiv.svg)](https://pypi.python.org/pypi/shiv)
        [![Build Status](https://travis-ci.org/linkedin/shiv.svg?branch=master)](https://travis-ci.org/linkedin/shiv)
        [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/vb9yht30n0iuy4y9?svg=true)](https://ci.appveyor.com/project/sixninetynine/shiv)
        [![Coverage Status](https://coveralls.io/repos/github/linkedin/shiv/badge.svg)](https://coveralls.io/github/linkedin/shiv)
        [![Documentation Status](https://readthedocs.org/projects/shiv/badge/?version=latest)](http://shiv.readthedocs.io/en/latest/?badge=latest)
        [![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause)
        [![Supported](https://img.shields.io/pypi/pyversions/shiv.svg)](https://pypi.python.org/pypi/shiv)
        
        ![snake](https://github.com/linkedin/shiv/raw/master/logo.png)
        
        # 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.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:
        
        ```sh
        $ 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:
        
        ```sh
        $ 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`
        
        ```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 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:
        
        ```sh
        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:
        
        * [PEX](https://github.com/pantsbuild/pex)
        * [pyzzer](https://pypi.org/project/pyzzer/#description)
        * [superzippy](https://github.com/brownhead/superzippy)
        
        Logo by Juliette Carvalho
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
