Skip to main content
Qhub logo on white background

Information Links
Project License QHUb documentation PyPI version
Community GH discussions Open an issue
CI Kubernetes Tests Tests

Table of contents

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

QHub is an open source tool that enables users to build and maintain cost-effective and scalable compute/data science platforms on HPC or on Kubernetes with minimal DevOps experience.

This repository details the QHub (Kubernetes) version.

Not sure what to choose? Check out our Setup Initialization page.

QHub HPC

Version of QHub based on OpenHPC.

NOTE: The tool is currently under development. Curious? Check out the Qhub HPC repository.

QHub

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

QHub aims to abstract all these complexities for its users. Hence, it is not necessary to know any of the above mentioned technologies 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: Cloud Providers

QHub offers out-of-the-box support for Digital Ocean, Amazon AWS, GCP, and Microsoft Azure.

High-level illustration of QHub architecture

For more details, check out the release blog post.

:computer: Installation

Pre-requisites

  • QHub is supported by macOS and Linux operating systems (Windows is NOT currently supported).
  • Compatible with Python 3.7+. New to Python? We recommend using Anaconda.
  • Adoption of virtual environments (conda, pipenv or venv) is also encouraged.

Install QHub

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

  • Install using conda:

    conda install -c conda-forge qhub
    
  • Install using pip:

    pip install qhub
    

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

qhub --help

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

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

QHub command line

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

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

:label: Usage

QHub requires the setting of environment variables to automate the deployments fully. For details on how to obtain those variables, check the installation guide in the docs.

Once all the necessary credentials are gathered and set as UNIX environment variables, QHub can be deployed in under 20 minutes using:

qhub init   ... # generates initial config file and optionally automates deployment steps
qhub deploy ... # creates and configures the cloud infrastructure

:question: Questions?

Have a look at our FAQ to see if your query has been answered.

We separate the queries for QHub into:

  • GitHub Discussions used to raise discussions about a subject, such as: "What is the recommended way to do X with QHub?"

  • Issues for queries, bug reporting, feature requests,documentation, etc.

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

:book: Code of Conduct

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

:gear: Installing the Development version of QHub

To install the latest developer version (unstable) use:

pip install git+https://github.com/Quansight/qhub.git@dev

:raised_hands: Contributions

Thinking about contributing? Check out our Contribution Guidelines.

Ongoing Support

The v0.4.0 release introduced many changes that will irrevocably break your deployment if you attempt an inplace upgrade; for details see our RELEASE notes. In order to focus on the future direction of the project, we have decided as a team that we will provide limited support for older versions. Any new user is encouraged to use v0.4.0 or greater.

If you're using an older version of QHub and would like professional support, please reach out to Quansight.

License

QHub is BSD3 licensed.

Metadata

Release files for qhub 0.4.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qhub 0.4.4
File Size Uploaded Provenance Actions
qhub-0.4.4.tar.gz 355.3 kB Without provenance Details for qhub-0.4.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for qhub 0.4.4
File Interpreter ABI Platform Actions
qhub-0.4.4-py3-none-any.whl Python 3 none any Details for qhub-0.4.4-py3-none-any.whl

Total release size: 751.3 kB

Release files / qhub-0.4.4.tar.gz

Download URL qhub-0.4.4.tar.gz
Size 355.3 kB
Tags Source
SHA-256 checksum
How to use checksums
7ed056ed83ae7ef63457b89f42d9c8de493303110771e2a84f23a55732cf8164
BLAKE2b-256 checksum
How to use checksums
fe269a11dda76a8d4ac0743fc7d193ee84f66f26effd62028bcae59fd3bd2f08
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.14

Release files / qhub-0.4.4-py3-none-any.whl

Download URL qhub-0.4.4-py3-none-any.whl
Size 396.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ca0f6fa5c5f2bea2a304f21ea111280247e30dc0099056f8df8f1c224c9760f5
BLAKE2b-256 checksum
How to use checksums
7011ad23548ad15652e731c5d5244a76c71a2cae230594f0f43efe01cb0f53f2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.14

Security for qhub 0.4.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.4.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page