IDTAP API Documentation

The IDTAP API is a Python client library for the Interactive Digital Transcription and Analysis Platform, designed specifically for transcribing, analyzing, and managing Hindustani music recordings.

Note

This is the client API documentation. For the main IDTAP web application, visit swara.studio.

Quick Start

Install the package from PyPI:

pip install idtap

Basic usage:

from idtap import SwaraClient, login_google

# Authenticate with Google OAuth
login_google()

# Create client and get transcriptions
client = SwaraClient()
transcriptions = client.get_transcriptions()

Contents:

• Installation
  • Requirements
  • Install from PyPI
  • Install from Source
  • Development Installation
  • Platform-Specific Notes
  • Verification
• Authentication
  • Quick Authentication
  • Using the Client
  • Token Storage
  • Security Features
  • Manual Token Management
  • Troubleshooting Authentication
  • Environment Variables
  • Multiple Accounts
• Quickstart Guide
  • Installation and Authentication
  • Basic Operations
  • Audio Management
  • Data Export
  • Common Patterns
  • Next Steps
• User Guide
  • Table of Contents
  • Overview
  • Key Concepts
  • Getting Help
  • Next Steps
• API Reference
  • Core Client
  • Data Models
  • Utilities
  • Quick Reference
• Examples
  • Code Examples
  • Common Patterns
  • Next Steps

Features

• OAuth Authentication - Secure Google OAuth integration with token storage

• Rich Data Models - Comprehensive classes for musical transcription data

• Audio Management - Upload, download, and manage audio files

• Spectrogram Analysis - CQT spectrogram visualization with matplotlib integration

• Export Capabilities - Export transcriptions to JSON and Excel formats

• Permissions System - Manage public/private visibility and sharing

Indices and tables

• Index

• Module Index

• Search Page