Code Monkey home page Code Monkey logo

docs's Introduction

description cover coverY
These Docs will help you get started with Naas quickly, guide you through advanced features, and explain the core concepts that make Naas unique.
0

Get Started

{% hint style="warning" %} This documentation is in beta. It may change frequently. To propose changes or enhancements, please create a GitHub Issue. {% endhint %}

Welcome to Naas!

Notebooks as a service (Naas) is an open source platform that allows anyone touching data (analysts, scientists and engineers) to create powerful data solutions combining automation, analytics and AI from the comfort of their Jupyter notebooks.

Naas is an alternative to Google Colab, with superpowers.

The platform upgrades notebooks with 3 low-code layers to get things done faster: features, drivers, and templates.

  • ****Templates enable the user to create automated data jobs and reports in minutes.
  • ****Drivers act as connectors to push and/or pull data from databases, APIs, Machine Learning algorithms, and more.
  • ****Features transform Jupyter in a production-ready environment with scheduling, asset sharing, and notifications.

Naas Cloud

Naas cloud is the fastest and easiest way to get you started!

Try all of Naas's features for free using Naas cloud a stable environment, without having to install anything.

How to use Naas Cloud?

Start with templates

The easiest way to go is simply to find the right template for you.

{% content-ref url="templates.md" %} templates.md {% endcontent-ref %}

Naas services

Naas creates a dynamic production environment for your Notebooks. Each time you run the following formulas in a notebook, it will be sent into the "โšก๏ธ โ†’ Production" folder" for execution.

To get started, create a folder, open a notebook, and import Naas :

import naas

Schedule your notebook

Send in production this notebook and run it, every day at 9:00

naas.scheduler.add(cron="0 9 * * *")

{% content-ref url="features/scheduler.md" %} scheduler.md {% endcontent-ref %}

Add a dependency

Send in production any file type like test.csv as a dependency:

naas.dependency.add("test.csv")

{% content-ref url="features/dependency.md" %} dependency.md {% endcontent-ref %}

Add a secret key

Copy in production any secret key :

naas.secret.add(name="API_NAME", secret="API_KEY")

Remove the previous line and get your secret key with :

naas.secret.get(name="MY_API_KEY")

This allows you to push your notebook in production without sensitive data getting exposed.

{% content-ref url="features/secret.md" %} secret.md {% endcontent-ref %}

Trigger Webhook

Copy in production this notebook and allow to run it by calling the returned URL:

naas.webhook.add()

Call the URL with your navigator you will get a message and see the notebook has run.

If you want to download the notebook result instead, add this line:

naas.webhook.respond_notebook()

{% content-ref url="features/api.md" %} api.md {% endcontent-ref %}

Expose assets

Copy in production this asset ( file ) and allow to get it by calling the returned url:

link = naas.assets.add("tesla-chart.html")

{% content-ref url="features/asset.md" %} asset.md {% endcontent-ref %}

Send notifications

Send an email notification to anyone, to notify about data changes, alert on notebooks operations, etc...

# Get link var from previous step
email = "[email protected]"
subject = "The tesla action is going up"
content = "check in the link the chart data maide from fresh dataset : " + link
naas.notifications.send(email=email, subject=subject, content=content)

{% content-ref url="features/notification.md" %} notification.md {% endcontent-ref %}

Help

Open

If at any time you are lost, you need help, or just want some info!

import naas

naas.open_help()

That will open a chat box with us

Close help chat

import naas

naas.close_help()

Documentation

Show a button to quickly open this documentation from Jupyter

import naas
naas.doc()

Contributing

We value all kinds of contributions - not just code. We are particularly motivated to support new contributors and people who are looking to learn and develop their skills.

Please read our Contributing guidelines on how to get started.

Community Support

You can reach out to us through the following channels:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.