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.5.tar.gz (16.3 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.5-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vidnavigator-0.1.5.tar.gz
  • Upload date:
  • Size: 16.3 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.5.tar.gz
Algorithm Hash digest
SHA256 cc587ed2064415622f32ccde51fe3074a2f6cb3595c62385870f0bc8a3d44efc
MD5 66340cc1d4833f10cf16df3344996f8c
BLAKE2b-256 6d41c1a36b42bf828925e72c0f0a2d8d6982618e57bb50fa7a8d560728f26df4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vidnavigator-0.1.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 108f596ae55d03bf4bb81c7b17b70ad7fb7e309bb79dd232a96cb30776c9dd56
MD5 995bb1bb0cdac7b0b3db8ff96994e9d0
BLAKE2b-256 a90970400d01ba59e9b430b96df753e456c0654b8b83b0d1109aa008b026791f

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