Kalouk Python Package

Welcome to the Kalouk Python package documentation!

Note

Kalouk is a Python package that helps in creating metadata for datasets using Schema.org’s Dataset type and sending it to Kalouk’s API.

Installation

Install Kalouk using your preferred package manager:

uv

uv add kalouk

pip

pip install kalouk

conda

conda install -c conda-forge kalouk

Quick Start

Here’s how to get started with Kalouk:

from kalouk import Dataset

# Create a new dataset
dataset = Dataset()

# Set metadata using Schema.org Dataset properties
dataset.set_metadata("name", "My Dataset")
dataset.set_metadata("description", "A sample dataset")
dataset.set_metadata("creator", "John Doe")
dataset.set_metadata("dateCreated", "2025-01-01")
dataset.set_metadata("license", "https://creativecommons.org/licenses/by/4.0/")

# Send to Kalouk's API
response = dataset.send_to_kalouk()
print(f"Status: {response.status_code}")

Features

✅ Schema.org Compliant: Uses Schema.org’s Dataset specification for metadata
✅ API Integration: Direct integration with Kalouk’s API
✅ Type Safety: Full type hints and NumPy-style docstrings
✅ Well Documented: Comprehensive documentation with examples

Table of Contents

Documentation

• API Reference
  • kalouk module
  • kalouk.dataset module
  • Dataset Class Details

API Reference

For detailed API documentation, see the API Reference page.

---

Need Help?

If you encounter any issues or have questions, please check our documentation or reach out to the community.