https://github.com/seeM/Jim

Jim is a simple, beautiful Jupyter notebook editor for macOS
https://github.com/seeM/Jim

Last synced: 4 months ago
JSON representation

Jim is a simple, beautiful Jupyter notebook editor for macOS

• Host: GitHub
• URL: https://github.com/seeM/Jim
• Owner: seeM
• License: apache-2.0
• Created: 2023-02-16T11:07:01.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-05-31T15:52:28.000Z (about 1 year ago)
• Last Synced: 2024-01-16T10:47:09.444Z (5 months ago)
• Language: Swift
• Homepage:
• Size: 256 KB
• Stars: 25
• Watchers: 1
• Forks: 2
• Open Issues: 48
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - seeM/Jim - Jim is a simple, beautiful Jupyter notebook editor for macOS (Swift)

README

        
# Jim

Jim (Jupyter in macOS) is a simple, beautiful Jupyter notebook editor for macOS. Think [Bear](https://bear.app/), for [Jupyter](https://jupyter.org/).

**NB: Jim is in pre-alpha and therefore not yet very reliable. You may lose work due to an unknown bug. Use Jim at your own risk.**

https://github.com/seeM/Jim/assets/559360/332cea34-b32e-4bfb-a27f-b22e3773f4bb

## Contributing

All contributions to Jim are welcome! Here's how you can get Jim up and running on your computer.

### Get the project source

First ensure that you have installed [XCode](https://apps.apple.com/us/app/xcode/id497799835) from the app store.

Then clone this repo:

``` sh

git clone [email protected]:seeM/Jim.git

```

Open the project, either in XCode directly or via the command line:

``` sh

open Jim/Jim.xcodeproj

```

### Start a Jupyter Server

Jim connects to an existing [Jupyter Server](https://jupyter-server.readthedocs.io/en/latest/) which must be started either in another process or remotely. Install Jupyter Server if needed with:

``` sh

pip install jupyter-server

```

Then start the server:

``` sh

jupyter server

```

Note the server URL and token displayed in the logs, which are needed to login with Jim. For example, if your Jupyter Server produced the following logs:

```         

[C 2023-05-27 15:01:55.088 ServerApp]

    To access the server, open this file in a browser:

        file:///Users/seem/Library/Jupyter/runtime/jpserver-5988-open.html

    Or copy and paste one of these URLs:

        http://localhost:8888/?token=6dc6eebb717ed09c243da57a89bee6a30dba217fbd43ec15

        http://127.0.0.1:8888/?token=6dc6eebb717ed09c243da57a89bee6a30dba217fbd43ec15

```

The corresponding login URL would be `http://localhost:8888/` and the token would be `6dc6eebb717ed09c243da57a89bee6a30dba217fbd43ec15`

***Note: Jim doesn't yet have a login screen (see [issue #15](https://github.com/seeM/Jim/issues/15#issue-1676257828)). The login URL and token are currently hardcoded. You can use the command `jupyter server --port 8999 --ServerApp.token=testtoken123` to start a development server matching those hardcoded values, or change the values ([here](https://github.com/seeM/Jim/blob/7e14cd8e70df1057c6888e9126c3524066a41db5/Jim/Main/SidebarViewController.swift#L21)) to match your server's configuration.***

### Start Jim

Run Jim by clicking on the play button on the top left of the XCode toolbar or by pressing ⌘R.