Metadata-Version: 2.1
Name: shellingham
Version: 1.2.8
Summary: Tool to Detect Surrounding Shell
Home-page: https://github.com/sarugaku/shellingham
Author: Tzu-ping Chung
Author-email: uranusjr@gmail.com
License: ISC License
Keywords: shell
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=2.6,!=3.0,!=3.1,!=3.2,!=3.3

=============================================
Shellingham: Tool to Detect Surrounding Shell
=============================================

Shellingham detects what shell the current Python executable is running in.


Usage
=====

::

    >>> import shellingham
    >>> shellingham.detect_shell()
    ('bash', '/bin/bash')

``detect_shell`` pokes around the process's running environment to determine
what shell it is run in. It returns a 2-tuple:

* The executable name (without extension on Windows), always lowercased.
* The command used to run the shell.

``ShellDetectionFailure`` is raised if ``detect_shell`` fails to detect the
surrounding shell.


