Kaggle Hub Client Library
Installation
Install the kagglehub package with pip:
pip install kagglehub
Usage
Authenticate
Authenticating is only needed to access public resources requiring user consent or private resources.
First, you will need a Kaggle account. You can sign up here.
After login in, you can download your Kaggle API credentials at https://www.kaggle.com/settings by clicking on the "Create New Token" button under the "API" section.
You have 3 different options to authenticate.
Option 1: Calling kagglehub.login()
This will prompt you to enter your username and token:
import kagglehub
kagglehub.login()
Option 2: Read credentials from environment variables
You can also choose to export your Kaggle username and token to the environment:
export KAGGLE_USERNAME=datadinosaur
export KAGGLE_KEY=xxxxxxxxxxxxxx
Option 3: Read credentials from kaggle.json
Store your kaggle.json credentials file at ~/.kaggle/kaggle.json.
Alternatively, you can set the KAGGLE_CONFIG_DIR environment variable to change this location to $KAGGLE_CONFIG_DIR/kaggle.json.
Note for Windows users: The default directory is %HOMEPATH%/kaggle.json.
Download Model
The following examples download the answer-equivalence-bem variation of this Kaggle model: https://www.kaggle.com/models/google/bert
import kagglehub
# Download the latest version.
kagglehub.model_download('google/bert/tensorFlow2/answer-equivalence-bem')
# Download a specific version.
kagglehub.model_download('google/bert/tensorFlow2/answer-equivalence-bem/1')
Development
Prequisites
We use hatch to manage this project.
Follow these instructions to install it.
Tests
# Run all tests
hatch run test
# Run a single test file
hatch run test tests/test_<SOME_FILE>.py
Run kagglehub from source
# Download a model & print the path
hatch run python -c "import kagglehub; print('path: ', kagglehub.model_download('google/bert/tensorFlow2/answer-equivalence-bem'))"
Lint / Format
# Lint check
hatch run lint:style
hatch run lint:typing
hatch run lint:all # for both
# Format
hatch run lint:fmt
Coverage report
hatch cov
Build
hatch build
4 maintainers
Metadata
4 maintainers
Release files for kagglehub 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| kagglehub-0.1.4.tar.gz | 26.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kagglehub-0.1.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 50.8 kB
Release files / kagglehub-0.1.4.tar.gz
| Download URL | kagglehub-0.1.4.tar.gz |
|---|---|
| Size | 26.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
657f7ab1773a738f16ab13eea9689a461a4f50fb50f6ab4b0cbedbbf3610d114
|
|
BLAKE2b-256 checksum How to use checksums |
6fadd962ba0eb64b41ddb39481d6352d79eec70726a51524ff2943f7f983e49c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.5
|
Release files / kagglehub-0.1.4-py3-none-any.whl
| Download URL | kagglehub-0.1.4-py3-none-any.whl |
|---|---|
| Size | 24.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b3deff036b6478e187568ab9f35daa17d286bc82cd77ed5c825d296911386c86
|
|
BLAKE2b-256 checksum How to use checksums |
a9029a24812eb209c8f42831cdc34922d371e9f54034aef3d8f469e1edc13b69
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.5
|
Security for kagglehub 0.1.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.
