This repository contains the implementation of dataset loader for Parquet files.
Project description
aircheckdata: AIRCHECK Parquet Dataset Loader
A lightweight Python package and CLI tool for listing and loading AIRCHECK datasets, with built-in support for column selection, progress tracking, and automatic local caching. This is the Pythonic way to programmatically access datasets that are also available for download via the AIRCHECK website. Before using any dataset, please ensure you have read and agreed to the dataset agreement HitGen End User License Agreement (EULA)
✅ Best Practices
-
Use virtual environments to avoid dependency conflicts:
python -m venv .venv source .venv/bin/activate # On Windows use .venv\Scripts\activate
-
Always validate that your code respects data privacy and licensing terms.
-
Avoid storing large datasets in version control. Let
aircheckdatahandle caching.
📦 Installation
You can install the package from PyPI:
pip install aircheckdata
🔧 Usage in a Python Project (Virtual Environment)
aircheckdata can be used directly from your Python environment to:
- List pre-configured datasets
- View available columns and metadata
- Load datasets with optional filtering and progress indicators
Quick Start
List Datasets
from aircheckdata import list_datasets
datasets = list_datasets()
for name, desc in datasets.items():
print(f"{name}: {desc}")
View Available Columns
from aircheckdata import get_columns
columns = get_columns('HitGen','WDR91')
names = [item["name"] for item in columns]
print("Column Names: \n", names)
Load dataset
from aircheckdata import load_dataset
df = load_dataset('HitGen','WDR91', columns=['ECFP6','ECFP4','LABEL']) # Download specified data columns with progressbar or
df = load_dataset('HitGen','WDR91', columns=['ECFP6','ECFP4','LABEL'],show_progress=False) # Download specified data columns with without progressbar, this is more memory efficient and faster
df = load_dataset() # Download once, then cache locally (by default it loads HitGen WDR91 Target)
print(df.head())
Advanced Usage
# Load only selected columns
df = load_dataset('WDR91', columns=['ECFP6', 'ECFP4', 'LABEL'])
# Show progress while loading
df = load_dataset('WDR91', show_progress=True)
💻 CLI Usage
The aircheckdata CLI enables quick access to datasets via command-line:
aircheckdata --help
Options and Examples
| Option | Description |
|---|---|
list |
List all available datasets |
columns Provider Name "Target Name" |
Select columns to load or list columns of a dataset |
Examples
# List datasets
aircheckdata list
# View available columns for Distinct Target (defaults to HitGen WDR91 if no provider and Target name is given)
# aircheckdata columns
airctest columns <Provider Name> <Target Name>
airctest columns HitGen "WDR12"
📜 License and Terms of Use
This package is distributed under the MIT License. However, the datasets it provides access to are subject to the HitGen End User License Agreement (EULA).
⚠️ By using any dataset accessed via
aircheckdata, you agree to abide by the HitGen EULA.Please refer to the full license terms and conditions here: 👉 https://www.aircheck.ai/docs/HitGen.pdf
📚 Pre-configured Datasets
Currently available datasets include:
WDR91: A curated Parquet dataset provided by HitGen
🛠 Requirements
- Python 3.7+
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file airctest-1.5.0.tar.gz.
File metadata
- Download URL: airctest-1.5.0.tar.gz
- Upload date:
- Size: 17.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9eaa00fad6960765787e1e43aec09d1dea850c9594cbc32646eb0ccd7ee09605
|
|
| MD5 |
b02fefa2b42f3a54f86fa2ba91e9a9f4
|
|
| BLAKE2b-256 |
0c2e38dbaf480b4d4510668adb601d59205f9dcdb91da96c4f15c24bf2b61ef0
|
File details
Details for the file airctest-1.5.0-py3-none-any.whl.
File metadata
- Download URL: airctest-1.5.0-py3-none-any.whl
- Upload date:
- Size: 10.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9c3f3fb2183651ba11f9c8033f16669d8416a7f20965c676211145aa1486adc1
|
|
| MD5 |
51e38b8344a8ac837005a9b49a09d111
|
|
| BLAKE2b-256 |
880b809a893b92c7f97fe09f3423579bdf6d1632b4744eefcbda147b3d81a985
|