{"id":13776693,"url":"https://github.com/robots-from-jupyter/robotkernel","last_synced_at":"2025-05-07T05:51:12.008Z","repository":{"id":30349792,"uuid":"118098598","full_name":"robots-from-jupyter/robotkernel","owner":"robots-from-jupyter","description":"Robot Framework IPython kernel for Jupyter Notebook and JupyterLab","archived":false,"fork":false,"pushed_at":"2023-10-02T11:49:48.000Z","size":18010,"stargazers_count":78,"open_issues_count":29,"forks_count":16,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-14T18:06:18.091Z","etag":null,"topics":["jupyter","jupyter-kernel","jupyterlab","robotframework"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robots-from-jupyter.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-01-19T08:30:16.000Z","updated_at":"2025-02-19T19:04:43.000Z","dependencies_parsed_at":"2024-01-15T02:50:56.206Z","dependency_job_id":null,"html_url":"https://github.com/robots-from-jupyter/robotkernel","commit_stats":{"total_commits":570,"total_committers":6,"mean_commits":95.0,"dds":0.03157894736842104,"last_synced_commit":"13e02f3ffb4dda9cc93ccd3d1cbb4336b689286d"},"previous_names":[],"tags_count":55,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robots-from-jupyter%2Frobotkernel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robots-from-jupyter%2Frobotkernel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robots-from-jupyter%2Frobotkernel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robots-from-jupyter%2Frobotkernel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robots-from-jupyter","download_url":"https://codeload.github.com/robots-from-jupyter/robotkernel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252823693,"owners_count":21809709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jupyter","jupyter-kernel","jupyterlab","robotframework"],"created_at":"2024-08-03T18:00:31.679Z","updated_at":"2025-05-07T05:51:11.988Z","avatar_url":"https://github.com/robots-from-jupyter.png","language":"Jupyter Notebook","funding_links":[],"categories":["Tools"],"sub_categories":["(Interactive) Learning Tools"],"readme":"Robotkernel\n===========\n\n|Smoketest Badge|\n\nRobotKernel is a `Robot Framework`_ IPython_ kernel for `Jupyter Notebook`_ and JupyterLab_. It powers RobotLab_ – the Robot Framework JupyterLab distribution. Check a `video to see it in action`_ and `read the documentation`_.\n\nRobotKernel requires Python 3.6 or later with setuptools 40.5.0 later and Robot Framework Robot Framework 3.1 or later.\n\n.. |Smoketest Badge| image:: https://github.com/robots-from-jupyter/robotkernel/workflows/smoketest/badge.svg\n.. _video to see it in action: https://youtu.be/uYGh9_c3b7s\n.. _read the documentation: https://robots-from-jupyter.github.io/robotkernel/\n.. _Robot Framework: http://robotframework.org/\n.. _IPython: https://ipython.org/\n.. _Jupyter Notebook: https://jupyter.readthedocs.io/en/latest/\n.. _JupyterLab: https://jupyterlab.readthedocs.io/en/stable/\n.. _RobotLab: https://github.com/robots-from-jupyter/robotlab/releases\n\nFor alternative Robot Framework IPython kernel, check out `ipythonrobotframework`_ or `xeus-robot`_.\n\n.. _ipythonrobotframework: https://github.com/gtri/irobotframework\n.. _xeus-robot: https://github.com/jupyter-xeus/xeus-robot\n\n\nTry RobotKernel\n---------------\n\nYou can try RobotKernel instantly without installing it at MyBinder_ cloud:\n\n* Launch JupyterLab with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=lab/tree/example.ipynb\n\n* Launch Jupyter Notebook with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=tree/example.ipynb\n\nNote: Log | Report -links on saved notebooks may not be clickable `until notebook is \"trusted\"`__ (\"Trust Notebook\" in JupyterLab Commands) the related cells have been executed again.\n\n.. _MyBinder: https://mybinder.org/\n__ https://jupyter-notebook.readthedocs.io/en/latest/security.html#updating-trust\n\n\nInstall RobotKernel\n-------------------\n\nRobotKernel can be installed using the usual Python package manager tools, like pip:\n\n.. code:: bash\n\n   $ pip install robotkernel\n\nFor JupyterLab it is recommended to also install the Robot Framework syntax highlighting and Jupyter widgets support:\n\n.. code:: bash\n\n   $ jupyter labextension install jupyterlab_robotmode\n   $ jupyter labextension install @jupyter-widgets/jupyterlab-manager\n\nFor some environments it might be required to run the following command to manually register robotkernel as an available Jupyter kernel:\n\n.. code:: bash\n\n   $ python -m robotkernel.install\n\n\nExport to .robot\n----------------\n\nIt is possible to export Robot Framework Jupyter notebooks to regular plain text ``.robot`` files for usage without Jupyter:\n\n.. code:: bash\n\n   $ jupyter nbconvert --to script example.ipynb\n\n.. _nbconvert: https://nbconvert.readthedocs.io/\n\n\nExecute notebooks\n-----------------\n\nRobotKernel installs a script named ``nbrobot``. It can be used instead of Robot Framework's ``robot`` test runner to execute Robot Framework with ``.ipynb``-extension support:\n\n.. code:: bash\n\n   $ nbrobot example.ipynb\n\n\nHacking RobotKernel\n-------------------\n\nCreate and activate a new Python virtual environment:\n\n.. code:: bash\n\n    $ venv myenv\n    $ source myenv/bin/activate\n\nInstall Jupyter:\n\n.. code:: bash\n\n    $ pip install --upgrade pip setuptools\n    $ pip install jupyter\n\nClone this kernel:\n\n.. code:: bash\n\n    $ git clone https://github.com/robots-from-jupyter/robotkernel.git\n    $ cd robotkernel\n\nInstall the kernel into the virtualenv in develop mode:\n\n.. code:: bash\n\n    $ python setup.py develop\n    $ python -m robotkernel.install\n\nLaunch the jupyter:\n\n.. code:: bash\n\n    $ jupyter notebook\n\nReloading the kernel reloads the code.\n\n`Learn more about Jupyter kernel development.`__\n\n__ http://jupyter.readthedocs.io/en/latest/install.html\n\n\nNix-shell\n---------\n\nThis repository includes an opinionated environment for running and developing RobotKernel with Nix_ with `Cachix-powered binary cache`__.\n\n__ https://robots-from-jupyter.cachix.org/\n\nLaunch Jupyter Notebook with RobotKernel:\n\n.. code:: bash\n\n   $ nix-shell -E 'import (fetchTarball https://github.com/robots-from-jupyter/robotkernel/archive/master.tar.gz + \"/shell.nix\")' --run \"jupyter notebook\"\n\n.. _Nix: https://nixos.org/nix/\n\nLaunch JupyterLab with RobotKernel:\n\n.. code:: bash\n\n   $ nix-shell -E 'import (fetchTarball https://github.com/robots-from-jupyter/robotkernel/archive/master.tar.gz + \"/shell.nix\")'\n   $ jupyter labextension install jupyterlab_robotmode --app-dir=.jupyterlab\n   $ jupyter lab --app-dir=.jupyterlab\n   $ exit\n\nAdd ``--arg vim true`` to enable `vim bindings`_.\n\n.. _vim bindings: https://github.com/lambdalisue/jupyter-vim-binding\n\nOpen development environment with Nix:\n\n.. code:: bash\n\n    $ git clone https://github.com/robots-from-jupyter/robotkernel.git\n    $ cd robotkernel\n    $ nix-build setup.nix -A env  # to generate ./result/bin/python for IDE\n    $ nix-shell setup.nix -A develop\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobots-from-jupyter%2Frobotkernel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobots-from-jupyter%2Frobotkernel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobots-from-jupyter%2Frobotkernel/lists"}