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.2.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.2-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vidnavigator-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 55ed6fc5ab66451bc3052f6c1f3003d023ed85aca1e0d7269ad8496dd2282723
MD5 8fc0dde45ea228a5e1134a6721d576e0
BLAKE2b-256 1dd2cd5f30adff08d2166a82a58faff4a8b3719d8475c64f0296de07ffed8f08

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vidnavigator-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8dcc4f3e94ed2a91139700bdbfa790a05eabc2f2373e25b084febb9b0f3e4095
MD5 72155466b505884a7e6d261e0c13c84b
BLAKE2b-256 9a643a998d51541d7b1be3da9cb97a7962615e8a7219666d2841e8c6fdda4530

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