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.3.tar.gz (16.1 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.3-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vidnavigator-0.1.3.tar.gz
  • Upload date:
  • Size: 16.1 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.3.tar.gz
Algorithm Hash digest
SHA256 99ba2c16087a01b31d4ee0adebfe44b205b9718b1be41acdc66dc3f2197a3c05
MD5 dc309665c70bc35276ab744c67b42ed4
BLAKE2b-256 97e8ae6f2c6d452a436b31dfa9cec987c1caa41205af56d278f32656cdf0bf16

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vidnavigator-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 15.3 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 22919abf359465bc93d3643591a48d2354c48a43259c58ed5caddd28d8700eaf
MD5 aec93016dbb2c73fd15d9b0475de072b
BLAKE2b-256 19af5faa822d31c6411ddf70bc2de1d8ed3d07fdfd07b95fa5d08af1f2729d74

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