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  # or publish on PyPI

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.1.tar.gz (15.8 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.1-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vidnavigator-0.1.1.tar.gz
  • Upload date:
  • Size: 15.8 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.1.tar.gz
Algorithm Hash digest
SHA256 c8a5cae6325cd8d3d0006bf5d8c9d244a11747266f438e98ae16455df9dabed1
MD5 96fe628b316a5b73aac79e7bb03139c8
BLAKE2b-256 7c7301cb2ee2ce357acb106ee3323f64fb489738b0240449bf1583915dc2147d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vidnavigator-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 15.0 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f8b94a633bde71606b858cd9fe168f69961acee9f6452e27d2220f3bb75bd48a
MD5 d5b7ecbefca40203557bbd2931ddd2e7
BLAKE2b-256 07d72b62f6b424158934ebf5b20d9830b5a247b4610457f4c8f159d306741eb7

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