Metadata-Version: 2.0
Name: ipyk
Version: 0.1.4.1
Summary: IPython local kernel management utility
Home-page: https://github.com/lebedov/ipyk/
Author: Lev Givon
Author-email: lev@columbia.edu
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Framework :: IPython
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Requires-Dist: futures (>=3.0)
Requires-Dist: ipython (>=2.2.0)
Requires-Dist: setproctitle
Requires-Dist: six

Package Description
-------------------
IPyk is a command line utility for managing locally run IPython kernels.

.. image:: https://img.shields.io/pypi/v/ipyk.svg
    :target: https://pypi.python.org/pypi/ipyk
    :alt: Latest Version
.. Uncomment after pypi is migrated to warehouse and stats are re-enabled:
.. https://github.com/badges/shields/issues/716
.. .. image:: https://img.shields.io/pypi/dm/ipyk.svg
    :target: https://pypi.python.org/pypi/ipyk
    :alt: Downloads

Installation
------------
If you have `pip <http://www.pip-installer.org/>`_ installed, run::

    pip install ipyk

You can also download the source tarball, unpack, and run::

    python setup.py install

Usage
-----
Start a new kernel using the default IPython profile: ::

    ipyk -s

Start a new kernel using a specific profile: ::

    ipyk -s my_profile

List running kernels; depending on the version of IPython you are using, the 
kernel JSON files may be stored in different locations: ::

    ipyk -l
    0: /run/user/1000/jupyter/kernel-12345.json

Connect to a running kernel; note that the argument is the integer listed by 
``ipyk -l``, not the process ID: ::

    ipyk -c 0

After connecting to a running kernel, one can disconnect without killing the 
kernel by typing ``Ctrl-\``.

Terminate a running kernel: ::

    ipyk -k 0

Author
------
See the included `AUTHORS.rst
<https://github.com/lebedov/ipyk/blob/master/AUTHORS.rst>`_ file for more
information.


License
-------
This software is licensed under the `BSD License
<http://www.opensource.org/licenses/bsd-license>`_.  See the included
`LICENSE.rst <https://github.com/lebedov/ipyk/blob/master/LICENSE.rst>`_ file
for more information.


