{"id":26445164,"url":"https://github.com/adamj9431/notebook_xterm","last_synced_at":"2025-06-30T15:36:53.462Z","repository":{"id":27181684,"uuid":"111326965","full_name":"adamj9431/notebook_xterm","owner":"adamj9431","description":"A terminal emulator embedded in a IPython/Jupyter notebook.","archived":false,"fork":false,"pushed_at":"2022-02-03T22:43:35.000Z","size":25,"stargazers_count":27,"open_issues_count":8,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-31T08:06:20.316Z","etag":null,"topics":["ipython-magic","jupyter-extension","jupyter-notebook","terminal-emulators"],"latest_commit_sha":null,"homepage":null,"language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adamj9431.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-19T19:52:13.000Z","updated_at":"2025-02-05T08:25:34.000Z","dependencies_parsed_at":"2022-08-07T12:15:35.927Z","dependency_job_id":null,"html_url":"https://github.com/adamj9431/notebook_xterm","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/adamj9431/notebook_xterm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamj9431%2Fnotebook_xterm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamj9431%2Fnotebook_xterm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamj9431%2Fnotebook_xterm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamj9431%2Fnotebook_xterm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adamj9431","download_url":"https://codeload.github.com/adamj9431/notebook_xterm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamj9431%2Fnotebook_xterm/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262801713,"owners_count":23366608,"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":["ipython-magic","jupyter-extension","jupyter-notebook","terminal-emulators"],"created_at":"2025-03-18T11:15:23.750Z","updated_at":"2025-06-30T15:36:53.403Z","avatar_url":"https://github.com/adamj9431.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# notebook_xterm\n[![PyPI version](https://badge.fury.io/py/notebook-xterm.svg)](https://badge.fury.io/py/notebook-xterm)\n\nA fully-functional terminal emulator in an IPython/Jupyter notebook. This is useful for notebook environments that don't provide shell access. Uses [xterm.js](https://xtermjs.org) for a VT100-compliant Javascript terminal front-end component. Instead of an actual WebSocket, notebook_xterm uses the Javascript Jupyter cell execute function `Jupyter.notebook.kernel.execute()` as a channel to communicate between the Python runtime on the server (`TerminalServer`) and JavaScript runtime in the browser (`TerminalClient`).\n\n![notebook_xterm_animation](https://user-images.githubusercontent.com/1238730/33512219-7d093170-d6f9-11e7-905f-480d62d17cd2.gif)\n\n## Getting Started\nLink to an [Example notebook](example.ipynb).\n\nCheck out [IBM Data Science Experience](https://datascience.ibm.com/) for a free, managed data science platform that includes a Jupyter notebook server.\n\n----\n\nFrom within an IPython notebook, install the package using pip:\n```\n!pip install notebook_xterm\n```\n\nLoad the IPython extension. You'll need to reload the extension each time the notebook kernel starts. Alternatively, you can add notebook_xterm to the [configuration file](http://ipython.readthedocs.io/en/stable/config/extensions/index.html#using-extensions) to load it automatically.\n```\n%load_ext notebook_xterm\n```\n\nTo display a terminal, type the [magic function](http://ipython.readthedocs.io/en/stable/interactive/magics.html) `%xterm` in a blank cell:\n```\n%xterm\n```\n\n## Tested Environments\n+ [IBM Data Science Experience](https://datascience.ibm.com/)\n+ Jupyter 4.3.0\n+ Python 2 and 3\n\n## License\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n\n## Contributing\nPull requests welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamj9431%2Fnotebook_xterm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadamj9431%2Fnotebook_xterm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamj9431%2Fnotebook_xterm/lists"}