nebari

πŸͺ΄ Nebari - your open source data science platform

https://github.com/nebari-dev/nebari

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • βœ“
    CITATION.cff file
    Found CITATION.cff file
  • βœ“
    codemeta.json file
    Found codemeta.json file
  • βœ“
    .zenodo.json file
    Found .zenodo.json file
  • β—‹
    DOI references
  • β—‹
    Academic publication links
  • βœ“
    Committers with academic emails
    3 of 74 committers (4.1%) from academic institutions
  • β—‹
    Institutional organization owner
  • β—‹
    JOSS paper metadata
  • β—‹
    Scientific vocabulary similarity
    Low similarity (9.8%) to scientific vocabulary

Keywords

aws azure dask devops gcp infrastructure jupyter jupyterhub kubernetes python

Keywords from Contributors

closember meshes docs pypi package-management conda energy-system-model transformation particle distributed
Last synced: 6 months ago · JSON representation ·

Repository

πŸͺ΄ Nebari - your open source data science platform

Basic Info
  • Host: GitHub
  • Owner: nebari-dev
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage: https://nebari.dev
  • Size: 16.3 MB
Statistics
  • Stars: 307
  • Watchers: 14
  • Forks: 105
  • Open Issues: 318
  • Releases: 131
Topics
aws azure dask devops gcp infrastructure jupyter jupyterhub kubernetes python
Created almost 6 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Codeowners Security

README.md

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|

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: 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:

```bash conda install -c conda-forge nebari

# if you prefer using mamba mamba install -c conda-forge nebari ```

  • Install using pip:

bash pip install nebari

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

bash nebari --help

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

```bash 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:

bash 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.

Owner

  • Name: nebari-dev
  • Login: nebari-dev
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - name: "Nebari Development Team"
type: software
title: "Nebari"
version: 2024.4.1
date-released: 2024-04-20
url: "https://www.nebari.dev"
repository-code: "https://github.com/nebari-dev/nebari"

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 1,860
  • Total Committers: 74
  • Avg Commits per committer: 25.135
  • Development Distribution Score (DDS): 0.838
Past Year
  • Commits: 488
  • Committers: 22
  • Avg Commits per committer: 22.182
  • Development Distribution Score (DDS): 0.793
Top Committers
Name Email Commits
Chris Ostrouchov c****v@g****m 302
Marcelo Villa m****a@q****m 137
eskild 4****d 126
Vinicius D. Cerutti 5****c 126
Adam Lewis 2****s 125
Dan Lester d****n@i****m 118
Chuck McAndrew 6****d 116
Amit Kumar d****t@g****m 103
Tony Fast t****t@g****m 102
t-potts t****s@g****m 70
pre-commit-ci[bot] 6****] 51
smokestacklightnin 1****n 51
Prasun Anand p****p@g****m 47
Philip Meier g****r@p****e 44
Fangchen Li f****i@o****m 30
MichaΕ‚ Krassowski 5****i 23
Harsh Mishra e****r@g****m 22
sophia s****n@q****m 21
YuviPanda y****a@g****m 18
Lais Carvalho l****o@p****e 17
Josef Kellndorfer j****r 16
anirrudh a****7@g****m 15
sblair-metrostar 7****r 13
Pavithra Eswaramoorthy p****s@o****m 12
Tania Allard t****d@g****m 11
joneszc j****c@i****u 10
iameskild e****2@g****m 10
arjxn.py a****y@g****m 9
Ken Foster k****r@m****m 8
Nebari-sensei 1****i 7
and 44 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 701
  • Total pull requests: 642
  • Average time to close issues: 4 months
  • Average time to close pull requests: 19 days
  • Total issue authors: 61
  • Total pull request authors: 46
  • Average comments per issue: 2.41
  • Average comments per pull request: 1.82
  • Merged pull requests: 469
  • Bot issues: 0
  • Bot pull requests: 27
Past Year
  • Issues: 169
  • Pull requests: 238
  • Average time to close issues: 24 days
  • Average time to close pull requests: 12 days
  • Issue authors: 22
  • Pull request authors: 21
  • Average comments per issue: 1.38
  • Average comments per pull request: 1.59
  • Merged pull requests: 168
  • Bot issues: 0
  • Bot pull requests: 12
Top Authors
Issue Authors
  • Adam-D-Lewis (101)
  • viniciusdc (91)
  • dcmcand (80)
  • marcelovilla (74)
  • iameskild (59)
  • aktech (40)
  • kcpevey (39)
  • krassowski (28)
  • pavithraes (25)
  • sblair-metrostar (22)
  • costrouc (21)
  • pmeier (16)
  • kenafoster (16)
  • pt247 (12)
  • dharhas (12)
Pull Request Authors
  • Adam-D-Lewis (149)
  • viniciusdc (125)
  • marcelovilla (97)
  • dcmcand (92)
  • iameskild (54)
  • aktech (44)
  • krassowski (41)
  • fangchenli (36)
  • pre-commit-ci[bot] (35)
  • pmeier (29)
  • soapy1 (19)
  • nebari-sensei (17)
  • pt247 (15)
  • sblair-metrostar (14)
  • kenafoster (13)
Top Labels
Issue Labels
type: bug πŸ› (228) type: enhancement πŸ’…πŸΌ (155) needs: triage 🚦 (113) area: user experience πŸ‘©πŸ»β€πŸ’» (79) needs: investigation πŸ” (62) area: security πŸ” (59) area:developer-experience πŸ‘©πŸ»β€πŸ’» (48) type: release 🏷 (47) area: testing βœ… (46) area: CI/CD πŸ‘·πŸ½β€β™€οΈ (45) needs: discussion πŸ’¬ (43) provider: AWS (41) project: JATIC (37) area: nebari-cli (36) needs: PR πŸ“¬ (31) area: dependencies πŸ“¦ (31) area: integration/conda-store (30) good first issue (29) area: terraform πŸ’Ύ (28) type: maintenance πŸ›  (28) impact: medium 🟨 (27) area: k8s ⎈ (26) impact: high πŸŸ₯ (25) provider: GCP (21) area: integration/Argo (18) area: JupyterLab (18) provider: Azure (16) help wanted (16) impact: low 🟩 (15) area: documentation πŸ“– (15)
Pull Request Labels
needs: review πŸ‘€ (81) type: maintenance πŸ›  (36) status: approved πŸ’ͺ🏾 (34) area:developer-experience πŸ‘©πŸ»β€πŸ’» (31) area: testing βœ… (29) area: CI/CD πŸ‘·πŸ½β€β™€οΈ (29) type: enhancement πŸ’…πŸΌ (27) type: bug πŸ› (23) area: security πŸ” (23) area: dependencies πŸ“¦ (20) provider: AWS (20) area: documentation πŸ“– (20) area: user experience πŸ‘©πŸ»β€πŸ’» (18) status: in review πŸ‘€ (18) project: JATIC (15) type: release 🏷 (15) area: JupyterLab (14) area: k8s ⎈ (14) status: in progress πŸ— (13) DO-NOT-MERGE (13) "area: documentation πŸ“–" (13) area: nebari-cli (11) provider: Azure (11) needs: follow-up πŸ“« (8) area: community πŸͺ΄ (7) impact: high πŸŸ₯ (7) area: integration/conda-store (7) needs: changes 🧱 (7) provider: GCP (7) area: integration/Argo (6)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 484 last-month
  • Total dependent packages: 7
  • Total dependent repositories: 1
  • Total versions: 74
  • Total maintainers: 7
  • Total advisories: 1
pypi.org: nebari

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

  • Versions: 74
  • Dependent Packages: 7
  • Dependent Repositories: 1
  • Downloads: 484 Last month
Rankings
Dependent packages count: 3.1%
Stargazers count: 4.4%
Forks count: 5.0%
Average: 9.0%
Downloads: 10.7%
Dependent repos count: 21.8%
Last synced: 6 months ago

Dependencies

.github/workflows/release-notes-sync.yaml actions
  • BetaHuhn/repo-file-sync-action v1 composite
  • actions/checkout master composite
.github/workflows/release.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/run-precommit.yaml actions
  • actions/checkout v3 composite
  • pre-commit/action v3.0.0 composite
.github/workflows/test-provider.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact master composite
  • azure/login v1 composite
  • google-github-actions/setup-gcloud v0 composite
.github/workflows/test.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
  • auth0-python ==4.0.0
  • azure-identity ==1.6.1
  • azure-mgmt-containerservice ==16.2.0
  • bcrypt ==4.0.1
  • boto3 ==1.26.54
  • cloudflare ==2.11.1
  • kubernetes ==25.3.0
  • pydantic ==1.10.4
  • pynacl ==1.5.0
  • python-keycloak ==2.9.0
  • questionary ==1.10.0
  • rich ==13.2.0
  • ruamel.yaml ==0.17.21
  • typer ==0.7.0
.github/actions/publish-from-template/action.yml actions
  • JasonEtco/create-an-issue v2 composite
.github/workflows/generate_cli_doc.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v1 composite
  • peter-evans/create-pull-request v4 composite
  • tj-actions/verify-changed-files v12 composite
.github/workflows/test_aws_integration.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • aws-actions/configure-aws-credentials v1 composite
  • hashicorp/vault-action v2.5.0 composite
.github/workflows/test_helm_charts.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
tests/tests_e2e/package-lock.json npm
  • 213 dependencies
tests/tests_e2e/package.json npm
  • cypress ^6.8.0 development
  • js-yaml ^4.0.0 development
  • lodash ^4.17.21 development
.github/workflows/test_conda_build.yaml actions
  • actions/checkout v3 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/test_do_integration.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • hashicorp/vault-action v2.5.0 composite
.github/workflows/test_gcp_integration.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • google-github-actions/auth v1 composite
  • hashicorp/vault-action v2.5.0 composite
.github/workflows/test_local_integration.yaml actions
  • actions/checkout main composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • azure/setup-kubectl v3 composite
  • conda-incubator/setup-miniconda v2 composite
  • cypress-io/github-action v6 composite
.github/workflows/typing.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite