Skip to content

Commit 33f9224

Browse files
committed
modified setup and readme
1 parent 140e9f0 commit 33f9224

File tree

6 files changed

+16
-19
lines changed

6 files changed

+16
-19
lines changed

.github/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ Make sure to take in account any existing code change that require some feature
2020
- [ ] Code follows project coding standards
2121
- [ ] Tests have been added or updated
2222
- [ ] Code Review
23-
- [ ] Manual test after Merge
23+
- [ ] Manual test after merge
2424
- [ ] All checks passed

README.md

+5-11
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ coll.upload(url="https://www.youtube.com/watch?v=uak_dXHh6s4")
147147
* `coll.get_video(video_id)`: Returns Video, respective video object from given `video_id`
148148
* `coll.delete_video(video_id)`: Deletes the video from Collection
149149

150-
### 📂 Search inside multiple videos in a collection
150+
### 📂 Search inside collection
151151

152152
You can simply Index all the videos in a collection and use
153153
search method on collection to find relevant results.
@@ -164,19 +164,19 @@ results.play()
164164
```
165165
The result here has all the matching bits in a single stream from your collection. You can use these results in your application right away.
166166

167-
## 🌟 Explore more with Video object
167+
### 🌟 Explore the Video object
168168

169169
There are multiple methods available on a Video Object, that can be helpful for your use-case.
170170

171-
### Access Transcript
171+
**Access Transcript**
172172
```python
173173
# words with timestamps
174174
text_json = video.get_transcript()
175175
text = video.get_transcript_text()
176176
print(text)
177177
```
178178

179-
### Add Subtitle to a video
179+
**Add Subtitle to a video**
180180

181181
It returns a new stream instantly with subtitle added into the video.
182182
```python
@@ -185,7 +185,7 @@ play_stream(new_stream)
185185
```
186186
**Get Thumbnail of Video:**
187187

188-
`video.get_thumbnail()`: Returns a thumbnail image of video.
188+
`video.generate_thumbnail()`: Returns a thumbnail image of video.
189189

190190
**Delete a video:**
191191

@@ -217,12 +217,6 @@ Contributions are what make the open source community such an amazing place to b
217217

218218
---
219219

220-
<!-- LICENSE -->
221-
## License
222-
223-
Distributed under the MIT License. See `LICENSE` for more information.
224-
225-
226220
<!-- MARKDOWN LINKS & IMAGES -->
227221
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
228222
[pypi-shield]: https://img.shields.io/pypi/v/videodb?style=for-the-badge

setup.py

+7-3
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ def get_version():
2121
setup(
2222
name="videodb",
2323
version=get_version(),
24-
author="Videodb",
24+
author="videodb",
2525
author_email="[email protected]",
26-
description="Videodb Python client",
26+
description="VideoDB Python SDK",
2727
long_description=long_description,
2828
long_description_content_type="text/markdown",
2929
url="https://github.com/video-db/videodb-python",
@@ -33,5 +33,9 @@ def get_version():
3333
"requests>=2.25.1",
3434
"backoff>=2.2.1",
3535
],
36-
36+
classifiers=[
37+
"Intended Audience :: Developers",
38+
"Programming Language :: Python :: 3",
39+
"Programming Language :: Python :: 3.9",
40+
],
3741
)

videodb/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
logger: logging.Logger = logging.getLogger("videodb")
1818

19-
__version__ = "0.0.1"
19+
__version__ = "0.0.2"
2020
__author__ = "videodb"
2121

2222
__all__ = [

videodb/_constants.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44
VIDEO_DB_API: str = "https://api.videodb.io"
5-
PLAYER_URL: str = "https://console.videodb.io/player"
5+
66

77

88
class SearchType:

videodb/_utils/_video.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import webbrowser as web
2-
3-
from videodb._constants import PLAYER_URL
2+
PLAYER_URL: str = "https://console.videodb.io/player"
43

54

65
def play_stream(url: str):

0 commit comments

Comments
 (0)