@nteract/commuter-client v1.0.0
com·mut·er
/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.
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/commuterUsage
Configure and run commuter with environment variables and commuter server.
Example local run (using a network file share!):
COMMUTER_LOCAL_STORAGE_BASEDIRECTORY=/efs/users/ commuterExample S3 run:
COMMUTER_BUCKET=sweet-notebooks commuterEnvironment Variables
General Environment Variables
| Environment Variable | Description | Default |
|---|---|---|
COMMUTER_STORAGE_BACKEND | local or s3 | local |
COMMUTER_DISCOVERY_BACKEND | either elasticsearch or none | "none" |
COMMUTER_PORT | Port to run commuter on | 4000 |
COMMUTER_LOCAL_STORAGE_BASEDIRECTORY | directory to serve in local storage mode | process.cwd() |
COMMUTER_ES_HOST | ElasticSearch Host | "" |
Environment Variables for S3 Storage
| Environment Variable | Description | 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_KEY | AWS Key | Optional, uses IAM roles or ~/.aws/credentials otherwise |
COMMUTER_S3_SECRET | AWS Secret | Optional, uses IAM roles or ~/.aws/credentials otherwise |
COMMUTER_S3_ENDPOINT | S3 endpoint | Optional, selected automatically |
Roadmap
Development
Quick Start
git clone git@github.com:nteract/commuter.gitcd commuteryarnyarn dev- open
http://localhost:4000
Tests
yarn test
Deployment
- Install commuter cli
yarn add @nteract/commuter exec commuter- the service is typically wrapped inside daemontools