py-mini-sh 0.1.2

Python Mini Shell

Note

Version: 0.1.2

This package provides helper functions to simplify the writing of platform-independent sh-like scripts in Python.

Full documentation can be found at Read-the-Docs, the source for which is in the docs folder.

Using this package

Either fetch this package directly from Git, or pull it from the Python Packaging index.

1. Pip-install from Git:

   pip install -U git+https://bitbucket.org/ltunmer/py_mini_sh.git

2. Pip-install from PyPI:

   pip install -U py_mini_sh

Dog Food

The script used to develop and test this component uses the py_mini_sh itself. To start development of this component, follow these steps:

1. Clone this repo onto a machine from https://bitbucket.org/ltunmer/py_mini_sh.git:

   git clone https://bitbucket.org/ltunmer/py_mini_sh.git

2. Cd to the py_mini_sh folder and run the buildall script in this folder:

   buildall 36

   The argument specifies which version of Python you wish to use. 27, 34, 35, and 36 are supported.

This buildall script will perform the following steps:

1. Builds a virtualenv derived from the specified version of Python.

2. Installs the py_mini_sh package into this virtualenv in “develop” mode.

3. Builds the documentation into the SHIP folder.

4. Runs pylint over the source and fails if the results are worse than the previous run.

5. Runs pytest tests which generate a coverage report into the SHIP folder.

6. Builds the bdist_wheel for this package into the SHIP folder.

License

This software is made available under the MIT License (see LICENSE.txt).