Skip to main content

A Jupyter and Dask-powered open source data science platform.

Project description

Nebari logo mark - text will be black in light color mode and white in dark color mode.

Your open source data science platform. Built for scale, designed for collaboration.


Information Links
Project License Nebari documentation PyPI conda version
Community GH discussions Open an issue Community guidelines
CI Kubernetes Tests Tests Test Nebari Provider
Cloud Providers AWS Deployment Status Azure Deployment Status GCP Deployment Status Digital Ocean Deployment Status

Table of contents

⚠️ Warning ⚠️ The 2023.10.1 release includes the initial implementation of a Pluggy-based extension mechanism, for more details refer here. This version also fully deprecates CDS Dashboards as it is no longer compatible with the newer versions of JupyterHub. For more details on all of changes included in this release, please refer to our release notes. After you've installed version 2023.10.1, you can update your nebari-config.yaml by running nebari upgrade -c nebari-config.yaml, please follow the upgrades instructions output by this command. And please make sure to back up your data before attempting an upgrade.

Automated data science platform. From JupyterHub to Cloud environments with Dask Gateway.

Nebari is an open source data platform that enables users to build and maintain cost-effective and scalable compute platforms on HPC or Kubernetes with minimal DevOps overhead.

This repository details the Nebari (Kubernetes) version.

Not sure what to choose? Check out our documentation on choosing a deployment platform

Nebari

The Kubernetes version of Nebari uses Terraform, Helm, and GitHub Actions.

  • Terraform handles the build, change, and versioning of the infrastructure.
  • Helm helps to define, install, and manage Kubernetes resources.
  • GitHub Actions is used to automatically create commits when the configuration file (nebari-config.yaml) is rendered, as well as to kick off the deployment action.

Nebari aims to abstract all these complexities for its users. Hence, it is not necessary to know any of the technologies mentioned above to have your project successfully deployed.

TLDR: If you know GitHub and feel comfortable generating and using API keys, you should have all it takes to deploy and maintain your system without the need for a dedicated DevOps team. No need to learn Kubernetes, Terraform, or Helm.

Cloud Providers ☁️

Nebari offers out-of-the-box support for the major public cloud providers: Digital Ocean, Amazon AWS, GCP, and Microsoft Azure. High-level illustration of Nebari architecture

Installation 💻

Pre-requisites

  • Operating System: Currently, Nebari supports development on macOS and Linux operating systems. Windows is NOT supported. However, we would welcome contributions that add and improve support for Windows.
  • You need Python >= 3.10 on your local machine or virtual environment to work on Nebari.
  • Adopting virtual environments (conda, pipenv or venv) is also encouraged.

Install Nebari

To install Nebari type the following commands in your command line:

  • Install using conda:

    conda install -c conda-forge nebari
    
    # if you prefer using mamba
    mamba install -c conda-forge nebari
    
  • Install using pip:

    pip install nebari
    

Once finished, you can check Nebari's version (and additional CLI arguments) by typing:

nebari --help

If successful, the CLI output will be similar to the following:

usage: nebari [-h] [-v] {deploy,destroy,render,init,validate} ...

Nebari command line

positional arguments:
  {deploy,destroy,render,init,validate}
                        Nebari

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         Nebari version

Usage 🚀

Nebari requires setting multiple environment variables to automate the deployments fully. For details on obtaining those variables, check the Nebari Get started documentation.

Once all the necessary credentials are gathered and set as UNIX environment variables, Nebari can be deployed in minutes.

For detailed step-by-step instructions on how to deploy Nebari, check the Nebari documentation.

Nebari HPC

An HPC version of Nebari is currently not available. There is one under development for Nebari's precursor QHub. Curious? Check out the QHub HPC repository.

Contributing to Nebari 👩🏻‍💻

Thinking about contributing? Check out our Contribution Guidelines to get started.

Installing the Development version of Nebari ⚙️

To install the latest developer version (unstable) use:

pip install git+https://github.com/nebari-dev/nebari.git

Questions? 🤔

Have a look at our Frequently Asked Questions (FAQ) to see if your query has been answered.

Getting help:

  • GitHub Discussions is our user forum. It can be used to raise discussions about a subject, such as: "What is the recommended way to do X with Nebari?"
  • Issues for queries, bug reporting, feature requests, documentation, etc.

We work around the clock to make Nebari better, but sometimes your query might take a while to get a reply. We apologize in advance and ask you to please, be patient :pray:.

Code of Conduct 📖

To guarantee a welcoming and friendly community, we require all community members to follow our Code of Conduct.

Ongoing Support

If you're using Nebari and would like professional support, please get in touch with the Nebari development team.

License

Nebari is BSD3 licensed.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

nebari-2024.11.1rc2.tar.gz (306.7 kB view details)

Uploaded Source

Built Distribution

nebari-2024.11.1rc2-py3-none-any.whl (331.8 kB view details)

Uploaded Python 3

File details

Details for the file nebari-2024.11.1rc2.tar.gz.

File metadata

  • Download URL: nebari-2024.11.1rc2.tar.gz
  • Upload date:
  • Size: 306.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for nebari-2024.11.1rc2.tar.gz
Algorithm Hash digest
SHA256 6c76d84d061e58c322f14ed74c97f59d80a59f151c4c18142dc9660101311bcc
MD5 95ed5a4ea0252660737029275f413de2
BLAKE2b-256 42fb26ce72f0245f0b48be30e97334729a436f8428c249e6fde755c8fe10400e

See more details on using hashes here.

Provenance

The following attestation bundles were made for nebari-2024.11.1rc2.tar.gz:

Publisher: release.yaml on nebari-dev/nebari

Attestations:

File details

Details for the file nebari-2024.11.1rc2-py3-none-any.whl.

File metadata

File hashes

Hashes for nebari-2024.11.1rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 53fa88eaf3e1fd8a6fe84d5c3fcee517f1c59420707f895ca7082de0a9ca6631
MD5 603ddf2d72a30ece30a6c8f5204e851c
BLAKE2b-256 01aee8522da0e669f090f7249d72798584c2cfdef8a6f376fa9acf8221b5cda0

See more details on using hashes here.

Provenance

The following attestation bundles were made for nebari-2024.11.1rc2-py3-none-any.whl:

Publisher: release.yaml on nebari-dev/nebari

Attestations:

Supported by

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