Introduction to notebook-shim

The world of data science and analytics is constantly evolving, and tools that enhance productivity are highly valued. One such tool is the notebook-shim, which provides a range of useful APIs to improve your Jupyter Notebook experience. In this post, we will dive into the capabilities of notebook-shim, showcasing various APIs and practical examples to get you started.

API Examples

1. Importing Notebook Shim

To get started with notebook-shim, you first need to import it. Below is a simple example to import the library:

  import notebook_shim as ns

2. Display Markdowns

Display Markdown text in your notebook using the function:

  
    ns.display_markdown("# Hello, World!")
  

3. Display HTML Content

The display_html function allows the insertion of HTML content. Here’s an example:

  
    ns.display_html("<b>Bold Text</b>")
  

4. Generating Alerts

Create alert messages within the notebook:

  
    ns.display_alert("This is an alert message!")
  

5. Display Tables

You can also display tables easily with the display_table function:

  
    data = {'Name': ['Alice', 'Bob'], 'Age': [25, 30]}
    ns.display_table(data)
  

App Example: Data Dashboard

Now, using the APIs from notebook-shim, let’s create a simple data dashboard that showcases Markdown content, tables, and HTML content.

  
    import notebook_shim as ns

    # Display title
    ns.display_markdown("# Simple Data Dashboard")

    # Display table
    data = {'Name': ['Alice', 'Bob'], 'Age': [25, 30], 'City': ['New York', 'San Francisco']}
    ns.display_table(data)

    # Display custom HTML
    ns.display_html("<i>Data retrieved successfully!</i>")
    
    # Display an alert
    ns.display_alert("Data loading complete.")
  

With these examples, you can start enhancing your Jupyter Notebook experience using notebook-shim. The versatility of the tool allows for better presentation of data, seamless integration of HTML, Markdown, and more.

Hash: f9162db1738117e24e0eb1f302da047c130e5f2459112e18123e47799ad4dd42