Skip to main content

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 aircheckdata handle 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airctest-1.3.0.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airctest-1.3.0-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file airctest-1.3.0.tar.gz.

File metadata

  • Download URL: airctest-1.3.0.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for airctest-1.3.0.tar.gz
Algorithm Hash digest
SHA256 569cfd80d068bce2a89129ddbd05fc89e2753b0f8c7dd14d5f3f174322d35f3a
MD5 6f4fe14e1f47a1d027ecbc5548837241
BLAKE2b-256 71dffda55573736bd8c7ed6aa25a6a0c2b2d48a536ea37c972ba130a3e642b1e

See more details on using hashes here.

File details

Details for the file airctest-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: airctest-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for airctest-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 817de124d449c84285ac47e4bdebce321b0c54b6872728b9f8c0776cd0c728a4
MD5 e9d87321ef4dac79a0a6789337ff7dd0
BLAKE2b-256 65bee89d3e76f29263a6ef8a2727ce796466f7360207a9e30fbbae191f7a2e15

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page