Implementation:Datahub project Datahub Pip Install Datahub Docker

Field	Value
Implementation Name	Pip Install Datahub Docker
Namespace	Datahub_project_Datahub
Workflow	Docker_Quickstart_Deployment
Type	External Tool Doc
Language	Python / pip
Last Updated	2026-02-10
Source Repository	datahub-project/datahub
Source File	metadata-ingestion/setup.py, lines 954-1108 (entry_points) and lines 1111-1185 (setuptools.setup)
Domains	Deployment, Docker, Metadata_Management

Overview

The acryl-datahub package is installed via pip and provides the datahub CLI entry point. For Docker deployment commands, no extras are needed -- the base installation includes all required dependencies for the docker subcommand group.

Installation Command

pip install acryl-datahub

No extras (e.g., [mysql], [snowflake]) are required for Docker commands.

Package Metadata

Field	Value
Package Name	acryl-datahub
PyPI URL	pypi.org/project/acryl-datahub
Python Requirement	>= 3.10
License	Apache-2.0
Console Entry Point	datahub = datahub.entrypoints:main

Entry Points Registration

The package defines a console script entry point in setup.py (line 955):

entry_points = {
    "console_scripts": ["datahub = datahub.entrypoints:main"],
    # ... plugin entry points ...
}

The docker subcommand group is added in entrypoints.py (line 362):

from datahub.cli.docker_cli import docker
datahub.add_command(docker)

Docker Subcommand Group

The docker Click group is defined in datahub.cli.docker_cli (line 143-147):

@click.group()
def docker() -> None:
    """Helper commands for setting up and interacting with a local
    DataHub instance using Docker."""
    pass

This group registers the following commands:

Command	Function	Description
datahub docker quickstart	quickstart()	Start the DataHub Docker stack
datahub docker check	check()	Check container health
datahub docker ingest-sample-data	ingest_sample_data()	Load demo metadata
datahub docker nuke	nuke()	Remove all DataHub containers and volumes

Key Framework Dependencies

The following dependencies from framework_common in setup.py (lines 37-68) are relevant to Docker operations:

Dependency	Version Constraint	Purpose
click	>=7.1.2,!=8.2.0,<9.0.0	CLI framework
docker	<8.0.0	Docker SDK for Python
PyYAML	<7.0.0	Compose file parsing
expandvars	>=0.6.5,<2.0.0	Environment variable expansion
requests	(via rest_common)	HTTP client for downloading compose files
requests_file	<4.0.0	File URI adapter for local compose files
click-spinner	<0.2.0	Progress spinner during image pulls

Usage Examples

# Install the package
pip install acryl-datahub

# Verify installation and version
datahub version

# List available docker commands
datahub docker --help

# Start DataHub locally
datahub docker quickstart

# Check container health
datahub docker check

# Load sample data
datahub docker ingest-sample-data

# Remove everything
datahub docker nuke

Knowledge Sources

• DataHub GitHub Repository
• DataHub Official Documentation
• PyPI: acryl-datahub

Related Pages

• Implements: Datahub_project_Datahub_CLI_Installation_For_Docker
• Datahub_project_Datahub_Docker_CLI_Quickstart
• Datahub_project_Datahub_Docker_CLI_Lifecycle
• Environment: Environment:Datahub_project_Datahub_Docker_Quickstart_Environment
• Environment: Environment:Datahub_project_Datahub_Python_3_10_Ingestion_Environment