<commit_before>.. contents:: Table of contents
   :depth: 2

Installation
============
Install the rk from PyPI
------------------------
::

    $ sudo pip install rk

Install the rk from GitHub
--------------------------
::

    $ sudo pip install git+git://github.com/korniichuk/rk#egg=rk

Upgrade the rk from PyPI
------------------------
::

    $ sudo pip install -U rk

or::

    $ sudo pip install --upgrade rk

.. important:: The rk set to dafault a kernels dict ``kernels.json``. Save a current kernels dict to home dir before upgrade, and replace default kernels dict file after.

Uninstall the rk
----------------
::

    $ sudo pip uninstall rk

Development installation
========================
::

    $ git clone git://github.com/korniichuk/rk.git
    $ cd rk
    $ sudo pip install .

Quickstart
==========

.. image:: ./img/quickstart_0001_550px.png
  :alt: quickstart [youtube video]
  :align: "right"
  :target: https://www.youtube.com/watch?v=joEIPZJUB94

**First**, make sure that you can login to a remote machine without entering password. The most basic form of the command is::

    $ ssh REMOTE_HOST

If your username is different on a remote machine, you can specify it by using this syntax::

    $ ssh REMOTE_USERNAME@REMOTE_HOST

Example::

    $ ssh albert@192.168.0.1

.. note:: You can `setup SSH for auto login without a password`_ like this: ``$ rk ssh``.

**Second**, install a template of a remote jupyter kernel::

    $ rk install-template

The rk created a template of a remote jupyter kernel inside system kernels location ``/usr/local/share/jupyter/kernels``.
A kernel identifies itself to jupyter by creating a directory, the name of which is used as an identifier for the kernel [1]_.

**Third**, change the ``kernel.json`` file::

   $ sudo gedit /usr/local/share/jupyter/kernels/template/kernel.json
<commit_msg>README.rst: delete align for image<commit_after>.. contents:: Table of contents
   :depth: 2

Installation
============
Install the rk from PyPI
------------------------
::

    $ sudo pip install rk

Install the rk from GitHub
--------------------------
::

    $ sudo pip install git+git://github.com/korniichuk/rk#egg=rk

Upgrade the rk from PyPI
------------------------
::

    $ sudo pip install -U rk

or::

    $ sudo pip install --upgrade rk

.. important:: The rk set to dafault a kernels dict ``kernels.json``. Save a current kernels dict to home dir before upgrade, and replace default kernels dict file after.

Uninstall the rk
----------------
::

    $ sudo pip uninstall rk

Development installation
========================
::

    $ git clone git://github.com/korniichuk/rk.git
    $ cd rk
    $ sudo pip install .

Quickstart
==========

.. image:: ./img/quickstart_0001_550px.png
  :alt: quickstart [youtube video]
  :target: https://www.youtube.com/watch?v=joEIPZJUB94

**First**, make sure that you can login to a remote machine without entering password. The most basic form of the command is::

    $ ssh REMOTE_HOST

If your username is different on a remote machine, you can specify it by using this syntax::

    $ ssh REMOTE_USERNAME@REMOTE_HOST

Example::

    $ ssh albert@192.168.0.1

.. note:: You can `setup SSH for auto login without a password`_ like this: ``$ rk ssh``.

**Second**, install a template of a remote jupyter kernel::

    $ rk install-template

The rk created a template of a remote jupyter kernel inside system kernels location ``/usr/local/share/jupyter/kernels``.
A kernel identifies itself to jupyter by creating a directory, the name of which is used as an identifier for the kernel [1]_.

**Third**, change the ``kernel.json`` file::

   $ sudo gedit /usr/local/share/jupyter/kernels/template/kernel.json

{'fraction_non_alphanumeric': 0.16133369185264856, 'fraction_numerical': 0.010217800484001076, 'mean_word_length': 2.875, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3125882', 'n_tokens_mistral': 1206, 'n_tokens_neox': 1082, 'n_words': 432}