# Video Summary SDK for Python
Enhance your video processing workflow with the `Video Summary SDK` for Python. This SDK offers a powerful and easy-to-use solution for transcribing, summarizing, and extracting chapter information from videos. It supports a wide range of sources, including local files and hosted URLs.
## Key Features
- **Transcription**: Accurately convert speech in videos into text.
- **Summarization**: Efficiently summarize video content.
- **Chapter Extraction**: Easily identify and extract distinct chapters from videos.
- **Versatile Source Support**: Compatible with local files, URLs, and various cloud storage solutions.
## Installation
Install the package using pip:
```bash
pip install video-summary
```
## Getting Started
First, obtain your free API key from [VideoSummary.io](https://videosummary.io?utm_source=github). Then, install the SDK and integrate it into your Python projects as follows:
```python
from video_summary import VideoSummarySDK
# Initialize the SDK with your API key
video_summary = VideoSummarySDK('your_api_key')
# Example usage
try:
# Local file path or hosted video URL
video_path = './path/to/your/video.mp4'
result = video_summary.summarize(video_path)
print("Video Summary Result:", result)
except Exception as e:
print("Error using Video Summary SDK:", e)
```
## API Methods
The Python SDK offers several methods to interact with your videos. The `id` and `callback_url` parameters are optional. The `id` can be used for your reference if you have an asset ID. The `callback_url` is for receiving a webhook when the video processing is completed.
If you don't provide a callback url, the call will be synchronous and wait for the processing to complete.
### `summarize(url, [id], [callback_url])`
Summarizes the video content. Provide the URL of the video, and optionally, include an ID and a callback URL for asynchronous processing.
### `transcribe(url, [id], [callback_url])`
Transcribes the audio content of the video into text. Input the video URL, and if desired, an ID and a callback URL.
### `chapter(url, [id], [callback_url])`
Extracts chapters from the video for easier navigation and understanding. This method requires the video URL, with optional ID and callback URL.
### `summarizeAndChapter(url, [id], [callback_url])`
Performs both summarization and chapter extraction on the video. Provide the video URL, and optionally, an ID and a callback URL.
Each method returns a response object containing relevant data about the video processing, including transcripts, summaries, chapters, and file IDs.
## output
```json
{
"transcript": {
"speakers": [
{
"speaker": "SPEAKER_00",
"text": " video",
"timestamp": [10,10.26],
"start": 10,
"end": 10.26
},
{
"speaker": "SPEAKER_00",
"text": " products.",
"timestamp": [10.26,10.9],
"start": 10.26,
"end": 10.9
}
],
"chunks": [
{ "text": " video", "timestamp": [Array] },
{ "text": " products", "timestamp": [Array] },
],
"text": "..."
},
"chapters": [
{
"start": 0,
"end": 10.9,
"title": "Introduction to VideoSummary.io",
"text": "Introducing videosummary.io. a simple api to transcribe, chapter and summarize audio and video files."
}
],
"summary": "Developers, check this out. You need VideoSummary.io in your life. It lets you build video products much easier with features like video summarization and video chaptering. Grab it now and start building game-changing video products.",
"fileId": "xxx-xxx-4ffc-a2a5-13d3cee085dd"
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Video-Summary/video-summary-python-sdk",
"name": "video-summary",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "video processing,speech-to-text,video summarization,transcription,chaptering",
"author": "Video Summary",
"author_email": "hi@videosummary.io",
"download_url": "https://files.pythonhosted.org/packages/58/b8/670c8d93bf08443f0b4741b9b9a3499af7a1a95b2ab20b27e45c32eba9c1/video-summary-1.0.3.tar.gz",
"platform": null,
"description": "# Video Summary SDK for Python\n\nEnhance your video processing workflow with the `Video Summary SDK` for Python. This SDK offers a powerful and easy-to-use solution for transcribing, summarizing, and extracting chapter information from videos. It supports a wide range of sources, including local files and hosted URLs.\n\n## Key Features\n\n- **Transcription**: Accurately convert speech in videos into text.\n- **Summarization**: Efficiently summarize video content.\n- **Chapter Extraction**: Easily identify and extract distinct chapters from videos.\n- **Versatile Source Support**: Compatible with local files, URLs, and various cloud storage solutions.\n\n## Installation\n\nInstall the package using pip:\n\n```bash\npip install video-summary\n```\n## Getting Started\n\nFirst, obtain your free API key from [VideoSummary.io](https://videosummary.io?utm_source=github). Then, install the SDK and integrate it into your Python projects as follows:\n\n```python\nfrom video_summary import VideoSummarySDK\n\n# Initialize the SDK with your API key\nvideo_summary = VideoSummarySDK('your_api_key')\n\n# Example usage\ntry:\n # Local file path or hosted video URL\n video_path = './path/to/your/video.mp4'\n result = video_summary.summarize(video_path)\n print(\"Video Summary Result:\", result)\nexcept Exception as e:\n print(\"Error using Video Summary SDK:\", e)\n```\n\n## API Methods\n\nThe Python SDK offers several methods to interact with your videos. The `id` and `callback_url` parameters are optional. The `id` can be used for your reference if you have an asset ID. The `callback_url` is for receiving a webhook when the video processing is completed. \n\nIf you don't provide a callback url, the call will be synchronous and wait for the processing to complete.\n\n### `summarize(url, [id], [callback_url])`\nSummarizes the video content. Provide the URL of the video, and optionally, include an ID and a callback URL for asynchronous processing.\n\n### `transcribe(url, [id], [callback_url])`\nTranscribes the audio content of the video into text. Input the video URL, and if desired, an ID and a callback URL.\n\n### `chapter(url, [id], [callback_url])`\nExtracts chapters from the video for easier navigation and understanding. This method requires the video URL, with optional ID and callback URL.\n\n### `summarizeAndChapter(url, [id], [callback_url])`\nPerforms both summarization and chapter extraction on the video. Provide the video URL, and optionally, an ID and a callback URL.\n\nEach method returns a response object containing relevant data about the video processing, including transcripts, summaries, chapters, and file IDs.\n\n\n\n\n\n## output\n```json \n{\n \"transcript\": {\n \"speakers\": [\n {\n \"speaker\": \"SPEAKER_00\",\n \"text\": \" video\",\n \"timestamp\": [10,10.26],\n \"start\": 10,\n \"end\": 10.26\n },\n {\n \"speaker\": \"SPEAKER_00\",\n \"text\": \" products.\",\n \"timestamp\": [10.26,10.9],\n \"start\": 10.26,\n \"end\": 10.9\n }\n ],\n \"chunks\": [\n { \"text\": \" video\", \"timestamp\": [Array] },\n { \"text\": \" products\", \"timestamp\": [Array] },\n ],\n \"text\": \"...\"\n },\n \"chapters\": [\n {\n \"start\": 0,\n \"end\": 10.9,\n \"title\": \"Introduction to VideoSummary.io\",\n \"text\": \"Introducing videosummary.io. a simple api to transcribe, chapter and summarize audio and video files.\"\n }\n ],\n \"summary\": \"Developers, check this out. You need VideoSummary.io in your life. It lets you build video products much easier with features like video summarization and video chaptering. Grab it now and start building game-changing video products.\",\n \"fileId\": \"xxx-xxx-4ffc-a2a5-13d3cee085dd\"\n}\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python SDK for video processing, providing functionalities like speech-to-text, summarization, transcription, and chaptering.",
"version": "1.0.3",
"project_urls": {
"Documentation": "https://github.com/Video-Summary/video-summary-python-sdk#readme",
"Homepage": "https://github.com/Video-Summary/video-summary-python-sdk",
"Source": "https://github.com/Video-Summary/video-summary-python-sdk",
"Tracker": "https://github.com/Video-Summary/video-summary-python-sdk/issues"
},
"split_keywords": [
"video processing",
"speech-to-text",
"video summarization",
"transcription",
"chaptering"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "83e6bda584a54b6a294a2764a64cac8971458abfc4d30a56f8e356be300aeb11",
"md5": "057d2ecdcfa397a4c0b928a82125f16b",
"sha256": "b23b8baafcbe4e3c38807623cfa7d5e8d4c003c9db167c8396f7846eb59bd289"
},
"downloads": -1,
"filename": "video_summary-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "057d2ecdcfa397a4c0b928a82125f16b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6157,
"upload_time": "2024-01-04T22:27:19",
"upload_time_iso_8601": "2024-01-04T22:27:19.804493Z",
"url": "https://files.pythonhosted.org/packages/83/e6/bda584a54b6a294a2764a64cac8971458abfc4d30a56f8e356be300aeb11/video_summary-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "58b8670c8d93bf08443f0b4741b9b9a3499af7a1a95b2ab20b27e45c32eba9c1",
"md5": "9aa525eebdc7529f4601564ece9a52dc",
"sha256": "886510ebd003b011895b89d81e0db60252f059977aabf2e4853fd0319fa20c97"
},
"downloads": -1,
"filename": "video-summary-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "9aa525eebdc7529f4601564ece9a52dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6004,
"upload_time": "2024-01-04T22:27:21",
"upload_time_iso_8601": "2024-01-04T22:27:21.427070Z",
"url": "https://files.pythonhosted.org/packages/58/b8/670c8d93bf08443f0b4741b9b9a3499af7a1a95b2ab20b27e45c32eba9c1/video-summary-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-04 22:27:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Video-Summary",
"github_project": "video-summary-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "video-summary"
}
JSON
