/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.
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.
You may use whichever package manager (
yarn) best suits your workflow. The
nteract team internally uses
npm install @nteract/commuter -g # OR yarn global add @nteract/commuter
Configure and run commuter with environment variables and
Example local run (using a network file share!):
Example S3 run:
General Environment Variables
||either elasticsearch or none||
||Port to run commuter on||4000|
||directory to serve in local storage mode||
Environment Variables for S3 Storage
||prefix on the bucket, similar to base directory||
||separator for "paths"||
||bucket contents served from||Required in S3 mode, no default|
||AWS Key||Optional, uses IAM roles or
||AWS Secret||Optional, uses IAM roles or
git clone firstname.lastname@example.org:nteract/nteract.git
- Install commuter cli
yarn add @nteract/commuter
exec commuter- the service is typically wrapped inside daemontools