Skip to main content

Jupyter Model Development Kit

Project description

Jupyter Model Development Kit (MDK)

The Jupyter MDK will allow a dramatic expansion of the capabilities of interactive View creation, by allowing seamless integration with the MMS along with leveraging collaborative Jupyter sessions.

It’s the vision that by utilising MMS’s element based storage and versioning scheme with Jupyter notebooks, and Python REST client libraries that can be used within a notebook, they can provide a more interactive and powerful way to construct Views while keeping the narrative oriented presentation of View Editor.

Quickstart

Prerequisites

Installation

  1. Install the latest jupyter-mdk PyPi package and its dependencies with pip install jupyter-mdk

  2. Locate your Jupyter config file or generate one with jupyter notebook --generate-config that defaults to ~/.jupyter.

  3. Add configuration for MMS integration, e.g.

    from mmscontents import MMSContentsManager
    
    c = get_config()
    
    # Tell Jupyter to use MMSContentsManager for all storage.
    c.NotebookApp.contents_manager_class = MMSContentsManager
    c.MMSContentsManager.mms_url = 'https://mms.yourcompany.com'
    c.MMSContentsManager.mms_project = '<project_id>'
    c.MMSContentsManager.mms_username = '<username>'
    c.MMSContentsManager.mms_password = '<password>'
    
  4. Run Jupyter as you normally would, e.g. jupyter notebook

  5. Test installation by creating a new notebook and saving. The notebook should not be in the local filesystem but instead accessible via MMS's REST API, e.g. https://mms.yourcompany.com/projects/<project_id>/refs/master/notebooks, to any user who has been granted access to the project both through MMS and Jupyter clients with Jupyter MDK similarly configured.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter-mdk-0.1.1.tar.gz (9.8 kB view details)

Uploaded Source

File details

Details for the file jupyter-mdk-0.1.1.tar.gz.

File metadata

  • Download URL: jupyter-mdk-0.1.1.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for jupyter-mdk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6d129573d1c934a3e1c6aeaf49b96ea9d690cd29832935718a69e6e4cb47d878
MD5 787238d51ee61715894c11129910d246
BLAKE2b-256 4f89384ae6454b530c04992353a414d1176d01f9b85db6ec10bd84a0e2b15368

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page