{"id":13756623,"url":"https://github.com/jupyter/atom-notebook","last_synced_at":"2025-04-07T11:09:06.777Z","repository":{"id":51329172,"uuid":"39856066","full_name":"jupyter/atom-notebook","owner":"jupyter","description":"[Deprecated] Jupyter Notebook, but inside Atom.","archived":false,"fork":false,"pushed_at":"2021-05-14T22:33:25.000Z","size":88,"stargazers_count":304,"open_issues_count":77,"forks_count":47,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-03-31T10:04:27.453Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/jupyter.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2015-07-28T20:26:07.000Z","updated_at":"2025-03-12T08:13:04.000Z","dependencies_parsed_at":"2022-09-05T20:20:38.155Z","dependency_job_id":null,"html_url":"https://github.com/jupyter/atom-notebook","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter%2Fatom-notebook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter%2Fatom-notebook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter%2Fatom-notebook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter%2Fatom-notebook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jupyter","download_url":"https://codeload.github.com/jupyter/atom-notebook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247640465,"owners_count":20971557,"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":[],"created_at":"2024-08-03T11:00:49.409Z","updated_at":"2025-04-07T11:09:06.756Z","avatar_url":"https://github.com/jupyter.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# jupyter-notebook\n\n\u003e This project does not have any active maintainers. We recommend that you use [nteract](https://nteract.io/desktop), a native notebook application built using Electron, React (like this project), Redux, and RxJS, or [Hydrogen](https://nteract.io/atom), a LightTable-inspired package for Atom that allows users to run code blocks and selections using Jupyter kernels.\n\nA package that works like the [Jupyter Notebook](http://jupyter.org/), but inside Atom. It's registered as an opener for `.ipynb` files — try opening one!\n\n![Sweet baby integration](http://i.imgur.com/100MtXR.png)\n\n## Install\n\n1. Install dependencies:\n\n ##### OS X\n\n  * Python 3: `brew install python3` (there are [issues](http://apple.stackexchange.com/questions/209572/how-to-use-pip-after-the-el-capitan-max-os-x-upgrade) with pip2 and OS X 10.11)\n  * Jupyter and Jupyter Kernel Gateway: `pip3 install jupyter jupyter_kernel_gateway`\n\n ##### Linux (Debian)\n\n  * Python: `sudo apt-get install python python-pip`\n  * Jupyter and Jupyter Kernel Gateway: `pip install jupyter jupyter_kernel_gateway`\n\n2. `apm install jupyter-notebook` or search for *jupyter-notebook* inside of Atom\n\n## Usage\n\n* Run cell: SHIFT+ENTER, CMD+ENTER (or CTRL+ENTER on Windows)\n\n## Developers\n\n### Install\n\n1. `git clone https://github.com/jupyter/atom-notebook.git`\n2. `apm install`\n3. `apm link`\n\n### Achitecture\n\nThis package is built on React and the Flux architecture.\n\n#### Map\n\n- **main** tells Atom how to render `NotebookEditor` and registers as an Opener for `.ipynb` files\n- **dispatcher** is a singleton flux.Dispatcher which contains the list of valid actions\n- **notebook-editor** is the Store and handles all of the business logic. It loads the file in, creates a state, then receives Actions and updates the state accordingly.\n- **notebook-editor-view**, notebook-cell, text-editor, display-area are the views. notebook-editor-view updates its state by fetching it from notebook-editor, then passes appropriate bits of that state down to the other views as props.\n\n#### Flow\n\n**Rendering:** `NotebookEditor -\u003e NotebookEditorView -\u003e [child views]`\n\n**Updating:** `[external action] -\u003e Dispatcher.dispatch -\u003e NotebookEditor.onAction ?-\u003e NotebookEditor._onChange -\u003e NotebookEditorView._onChange`\n\n#### Immutable state\n\nThe state returned by `NotebookEditor.getState` is an [`Immutable.js`](https://facebook.github.io/immutable-js/) object.\n\nAccessing its properties inside a view looks like this:\n\n```javascript\nlet executionCount = this.props.data.get('execution_count');\n```\n\nChanging it (in NotebookEditor) looks like this:\n\n```javascript\nthis.state = this.state.setIn(\n    ['cells', cellIndex, 'source'],\n    payload.source);\n```\n\nor this:\n\n```javascript\noutputs = outputs.push(el.outerHTML);\n```\n\nSince React requires a view's state to be a regular JS object, the state of NotebookEditorView takes the form:\n\n```javascript\n{\n    data: \u003cImmutable object\u003e\n}\n```\n\nNo other views have state.\n\n### To do\n\n- autocomplete\n  - `atom.workspace.getActiveTextEditor()` returns `undefined` because `atom.workspace.getActivePaneItem()` returns our custom NotebookEditor class which contains one or more TextEditors, therefore autocomplete, find, and features provided by other packages don't work in cells\n- add more actions (duplicate cell, restart kernel, change cell type, etc)\n- tell React [our rendering is pure](https://facebook.github.io/react/docs/advanced-performance.html)\n- test rendering performance with big notebooks\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjupyter%2Fatom-notebook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjupyter%2Fatom-notebook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjupyter%2Fatom-notebook/lists"}