Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamsocket/plane-data-jupyter
Jupyter lab variant with /plane-data as a base
https://github.com/jamsocket/plane-data-jupyter
Last synced: 2 months ago
JSON representation
Jupyter lab variant with /plane-data as a base
- Host: GitHub
- URL: https://github.com/jamsocket/plane-data-jupyter
- Owner: jamsocket
- License: mit
- Created: 2024-04-15T23:30:55.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-15T23:31:53.000Z (9 months ago)
- Last Synced: 2024-05-17T06:49:54.268Z (8 months ago)
- Language: Jupyter Notebook
- Size: 2.19 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jamsocket-jupyter-notebook
Base repo for running Jupyter Notebooks on the Jamsocket platform## Steps
1. Fork this repository.
2. Add your notebook(s) to the `/notebook` directory.
3. Add your notebook's python dependencies to `requirements.txt` (alternatively, if you prefer `pipenv`, add them with `pipenv install` and then run `pipenv run freeze`).
4. Replace `/notebooks/hello-jamsocket.ipynb` in `Dockerfile` with the path to the notebook you'd like to be automatically loaded. If you want the user to see a file listing of the `/notebooks` directory by default, remove that line entirely.
5. Run `./freeze.sh` to create a `freeze.txt` file from `requirements.txt`. This pins the version of all of the dependencies of the libraries in `requirements.txt`.
6. Set your account name as the `JAMSOCKET_ACCOUNT` value in your GitHub secrets.
7. Generate an access token at [app.jamsocket.com/settings](https://app.jamsocket.com/settings) and set it as the `JAMSOCKET_TOKEN` value in your GitHub secrets. ([Sign up](https://auth.jamsocket.com/signup) for a Jamsocket account if you don’t already have one.)
8. Push your repo to your GitHub account, and your Jupyter Notebook container will be automatically built and pushed to Jamsocket.
9. Get a Spawn URL from us. (Open this URL in a browser to start a new notebook instance.)## To run the jupyter-notebook locally for testing:
```bash
docker build -t jupyter-notebook .
docker run -p 8080:8080 --env PORT=8080 -it jupyter-notebook
open localhost:8080
```