On GitHub, nteract/commuter has picked up 502 stars, JavaScript. π Notebook sharing hub
Snapshot summary built from the project's own GitHub metadata β there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then β see the READ ME tab for the original README in full.
/kΙΛmyoΝodΙr/
a person who travels some distance to work on a regular basis.
As commuters, we rush around from place to place all day. We go to work,
school, and stores. We travel to locations near and far. Eventually, we
return to our cozy home. :car: :office: :airplane: :tokyo_tower: :bullettrain_side: :department_store: :bus: :school: :bike: :city_sunset: :runner: :house_with_garden:
Like commuters, our data travels around too. Sometimes we need a notebook at
work and other times at a client's site. Wherever and whenever you need your
notebooks, commuter has you covered.
What is "commuter"?
As an opinionated nteract focused server, commuter
reads notebooks from a local directory or Amazon S3, has a directory explorer to find notebooks,
and provides a jupyter compatible version of the contents API. You determine
where your notebooks should reside and where they should be shared. Flexibility
and convenience.
Try commuter today and take your notebooks wherever you need them.
Demo
Remix Demo
Demo Source
Installation
You may use whichever package manager (npm or yarn) best suits your workflow. The nteract team internally uses yarn.
npm install @nteract/commuter -g
# OR
yarn global add @nteract/commuter
Usage
Configure and run commuter with environment variables and commuter server.
Authentication to S3 is using CredentialProviderChain with default providers. This supports the most common ways of authenticating in AWS.
Environment Variable
Description
Default
AWS_ACCESS_KEY_ID
Specifies an AWS access key associated with an IAM user or role.
Optional
AWS_SECRET_ACCESS_KEY
Specifies the secret key associated with the access key. This is essentially the "password" for the access key.
Optional
AWS_SESSION_TOKEN
Specifies the session token value that is required if you are using temporary security credentials.
Optional
AWS_PROFILE
Specifies the name of the profile with the credentials and options to use. This can be the name of a profile stored in a credentials or config file
default
COMMUTER_S3_BASE_PREFIX
prefix on the bucket, similar to base directory
""
COMMUTER_S3_PATH_DELIMITER
separator for "paths"
"/"
COMMUTER_BUCKET
bucket contents served from
Required in S3 mode, no default
COMMUTER_S3_ENDPOINT
S3 endpoint
Optional, selected automatically
COMMUTER_S3_FORCE_PATH_STYLE
Set to true to activate s3ForcePathStyle. Forces path-style URLs for s3 objects, therefore URLs will be in the form <endpoint>/<bucket>/<key> instead of <bucket>.<endpoint>/<key>
false
Environment Variables for Google Storage
Environment Variable
Description
Default
GOOGLE_APPLICATION_CREDENTIALS
file path of the JSON file that contains your service account key
If you have your environment set up, you can run tests locally via yarn test.
This repository is also set up with GitHub Actions, a builtin CI system, which will automatically trigger test builds for multiple Node versions upon every push into this repository. You can then check out the results in the Actions tab.
These GitHub Actions can be triggered locally using act, this way you don't have to have your JavaScript environment set up and you don't have to commit and push in order to run the tests remotely through GitHub.
Deployment
Install commuter cli yarn add @nteract/commuter
exec commuter - the service is typically wrapped inside daemontools
Deployment (Docker / Kubernetes)
A Dockerfile intended for Production use (suitable for Kubernetes or other container runtime) has
been contributed. Instructions are below.
Note: there is no officially published Docker image at this time, you should publish it to your own
image registry.
Build and tag image docker build --tag commuter:latest .
Yes β nteract/commuter ships under the BSD-3-Clause license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/nteract/commuter.
What is nteract/commuter?
nteract/commuter (nteract/commuter) is a JavaScript project on GitHub. From the project's own README: π Notebook sharing hub
Where do I read more about nteract/commuter?
This TopGit page is a snapshot β the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/nteract/commuter is the definitive source.
Read full README in the tab above.
Curious whether commuter is right for you?
Let ChatGPT, Claude, or Perplexity look into it β click below and see what AI actually says about commuter.