https://github.com/lebedov/ipyk

IPython local kernel management utility
https://github.com/lebedov/ipyk

command-line ipython kernel

Last synced: 21 days ago
JSON representation

IPython local kernel management utility

• Host: GitHub
• URL: https://github.com/lebedov/ipyk
• Owner: lebedov
• License: other
• Created: 2015-01-18T16:32:14.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2018-03-29T12:05:13.000Z (over 6 years ago)
• Last Synced: 2024-09-14T12:24:51.499Z (about 2 months ago)
• Topics: command-line, ipython, kernel
• Language: Python
• Size: 27.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.rst

Awesome Lists containing this project

README

        
.. -*- rst -*-

IPyk

====

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

Installation

------------

If you have `pip `_ 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 running ``quit(keep_kernel=True)``.

Terminate a running kernel: ::

    ipyk -k 0

Author

------

See the included `AUTHORS.rst

`_ file for more

information.

License

-------

This software is licensed under the `BSD License

`_.  See the included

`LICENSE.rst `_ file

for more information.