CtrlK
BlogDocsLog inGet started
Tessl Logo

tessl/pypi-source-jina-ai-reader

Airbyte source connector for Jina AI Reader API enabling web content extraction and search through intelligent reading services

Pending

Quality

Pending

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

Overview
Eval results
Files

core-interface.mddocs/

Core Connector Interface

The main connector class and entry point functions that provide the foundation for Airbyte integration and command-line usage. These classes form the core interface for interacting with the Jina AI Reader connector.

Capabilities

Main Source Connector

The primary connector class that extends Airbyte's declarative source framework to provide Jina AI Reader functionality.

class SourceJinaAiReader(YamlDeclarativeSource):
    """
    Main connector class for Jina AI Reader source.
    
    Inherits from YamlDeclarativeSource and automatically loads configuration
    from the manifest.yaml file to define streams and connection behavior.
    """
    def __init__(self):
        """
        Initialize the source connector.
        
        Automatically configures the connector using the manifest.yaml file
        which defines the reader and search streams along with their schemas.
        """

Usage Example:

from source_jina_ai_reader import SourceJinaAiReader

# Create connector instance
source = SourceJinaAiReader()

# Use with Airbyte framework for spec, check, discover, read operations

Entry Point Function

The main entry point function for command-line execution of the connector.

def run() -> None:
    """
    Main entry point for the connector.
    
    Handles command-line arguments, applies configuration migrations,
    and launches the connector using Airbyte's entrypoint system.
    
    This function:
    1. Creates a SourceJinaAiReader instance
    2. Applies any necessary config migrations via JinaAiReaderConfigMigration
    3. Launches the connector with sys.argv arguments
    
    Usage:
    - Called automatically when using: poetry run source-jina-ai-reader
    - Called from main.py when running the connector directly
    """

Usage Example:

from source_jina_ai_reader.run import run

# Run the connector (typically called from command line)
run()

Command Line Interface

The connector provides standard Airbyte operations through the command line:

# Get connector specification (configuration schema)
poetry run source-jina-ai-reader spec

# Validate configuration
poetry run source-jina-ai-reader check --config secrets/config.json

# Discover available streams and their schemas  
poetry run source-jina-ai-reader discover --config secrets/config.json

# Read data from configured streams
poetry run source-jina-ai-reader read --config secrets/config.json --catalog catalog.json

Integration with Airbyte Framework

The connector integrates seamlessly with Airbyte's declarative framework:

  • YamlDeclarativeSource: Inherits standard Airbyte source behavior
  • Manifest-driven: Configuration defined in manifest.yaml
  • Standard Operations: Supports spec/check/discover/read operations
  • Stream Definition: Two streams (reader, search) with JSON schemas
  • Authentication: Optional Bearer token authentication
  • Error Handling: Built-in Airbyte error handling and logging

Install with Tessl CLI

npx tessl i tessl/pypi-source-jina-ai-reader

docs

configuration.md

core-interface.md

data-streams.md

http-handling.md

index.md

tile.json