Skip to main content

Python SDK for the VidNavigator Developer API

Project description

vidnavigator-python

Python SDK for the VidNavigator Developer API

Installation

pip install vidnavigator

Quickstart

from vidnavigator import VidNavigatorClient

client = VidNavigatorClient(api_key="YOUR_API_KEY")

# Health check
print(client.health_check())

# Fetch transcript from YouTube
resp = client.get_transcript(
    video_url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"
)

# Get data as dictionary
data = resp.data.model_dump()  # We use pydantic for object formatting
print(data['video_info'])  # Get video metadata
print(data['transcript'])  # Get video transcript

# AI analysis
resp = client.analyze_video(
    video_url="https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    query="What is the main topic discussed?",
)
analysis = resp.data.transcript_analysis
print(analysis.summary)
print(analysis.query_answer)

Using a Context Manager

from vidnavigator import VidNavigatorClient

with VidNavigatorClient(api_key="YOUR_API_KEY") as vn:
    results = vn.analyze_video(
        video_url="https://www.youtube.com/watch?v=dQw4w9WgXcQ",
        query="What is the main topic discussed?")
    print(results)

More Examples & Documentation

For a comprehensive set of usage examples covering more SDK features, please see the test.py

For full API documentation, visit docs.vidnavigator.com.

License

This SDK is licensed under the Apache License 2.0. See the LICENSE file for details.

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

vidnavigator-0.1.4.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

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

vidnavigator-0.1.4-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file vidnavigator-0.1.4.tar.gz.

File metadata

  • Download URL: vidnavigator-0.1.4.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for vidnavigator-0.1.4.tar.gz
Algorithm Hash digest
SHA256 4eadbd914fddd6d0ed29c159b40f8aa592a2706e6a8d9d2630c8a44362710710
MD5 159331afda3bd83e89698e3abc65c815
BLAKE2b-256 de28044c430577c5f543192ae11fa12fdb712adb5ee02f1e8bfbce4773ac3c6c

See more details on using hashes here.

File details

Details for the file vidnavigator-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: vidnavigator-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for vidnavigator-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0bd277e90b5a7142e8a904bb8e24b34b63683b633e0b52478353593de2ecb8ed
MD5 8d01bbf7eb7521caf7dd0f42a055ac76
BLAKE2b-256 ad2a930d59ec2eea693e7c9b0607215649d18cebe285e4b7ca7746430e29c3bd

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