Metadata-Version: 2.4
Name: ipyfernel
Version: 0.0.1
Summary: Remote execution of solveit/jupyter cells
Home-page: https://github.com/drscotthawley/ipyfernel
Author: Scott H. Hawley
Author-email: scott.hawley@belmont.edu
License: Apache Software License 2.0
Keywords: nbdev jupyter notebook python
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jupyter_client
Requires-Dist: ipython
Requires-Dist: sshpyk
Provides-Extra: dev
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# ipy*fern*el 🔥


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

### Choice of Name

It’s a remote kernel, so this is a play on words: `ipykernel` + the
German word/prefix “fern” meaning “remote” as in Fernseher for
television (lit: “remote viewer”). Plus maybe it sounds a bit like
“infernal,” which is 🔥

## Developer Guide

If you are new to using `nbdev` here are some useful pointers to get you
started.

### Install ipyfernel in Development mode

``` sh
# make sure ipyfernel package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to ipyfernel
$ nbdev_prepare
```

## Usage

### Installation

Install latest from the GitHub
[repository](https://github.com/drscotthawley/ipyfernel):

``` sh
$ pip install git+https://github.com/drscotthawley/ipyfernel.git
```

or from [pypi](https://pypi.org/project/ipyfernel/)

``` sh
$ pip install ipyfernel
```

### Documentation

Documentation can be found hosted on this GitHub
[repository](https://github.com/drscotthawley/ipyfernel)’s
[pages](https://drscotthawley.github.io/ipyfernel/). Additionally you
can find package manager specific guidelines
[pypi](https://pypi.org/project/ipyfernel/).

## How to use

See the [demo](https://drscotthawley.github.io/ipyfernel/demo.html) for
examples.

**TODO:** Add more examples!
