Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Release VidGear Stable v0.2.3 #262

Merged
merged 23 commits into from Oct 27, 2021
Merged

Release VidGear Stable v0.2.3 #262

merged 23 commits into from Oct 27, 2021

Conversation

abhiTronix
Copy link
Owner

@abhiTronix abhiTronix commented Oct 27, 2021 •
edited

Description

New vidgear stable release is here with focus on bug fixes and improvements to its APIs. 🎉

Key Changes:

📓 Complete Release Notes can be found here ↗️

New Features ✨

  • CamGear:
    • Added support for 4K Streaming URLs.
  • Helper:
    • Implemented logging ColorFormatter string alignment.

Updates/Improvements ⚡️

  • CamGear:
    • Replaced youtube-dl with yt-dlp as pafy backend.
      • Implemented hack to trick pafy into assuming yt-dlp as youtube-dl.
      • Replaced youtube-dl dependency with yt-dlp.
      • Replaced youtube-dl imports with yt-dlp.
        -Helper:
    • Enabled logging for check_WriteAccess method.
  • Maintenance:
    • Added .gitignore for specifying intentionally untracked files to ignore
    • Added .gitattributes to manage how Git reads line endings.
    • Introduced python short-circuiting for handling logging logic in APIs.

Breaking Updates/Changes 💥

  • check_WriteAccess will now return as invalid path if writing directory does not exists. This will effect output file handling in WriteGear and StreamGear APIs.

Bug-fixes 🐛

  • StreamGear:
  • WriteGear:
    • Fixed bug in -disable_force_termination attribute logic which accidentally disables force termination.
  • WebGear_RTC:
    • Fixed name 'VideoStreamTrack' is not defined bug.
  • Setup.py:
    • Fixed TypeError bug.
    • Fixed invalid latest_version retrieval.
  • Helper:
    • Fixed check_WriteAccess failing to recognize correct permission for writing the output file on windows platform.
      • Implemented separate logic for Windows and *nix platforms.
    • Fixed bug in check_WriteAccess that throws OSError while handling URLs.

Requirements / Checklist

Related Issue

#254
#259
#260
#261
#246
#251
#248

Context

VidGear's next milestone release i.e. v0.2.3 with main focus on critical bug fixes, performance improvements for its API, , user-friendly docs and lots of under the hood enhancements.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

abhiTronix and others added 22 commits September 2, 2021 21:38
@abhiTronix
🐛 Setup.py: Fixed TypeError bugs.
f31927f
Closes #258 (Removed extra %v character)
b70c0eb
Added .gitignore to ignore pycaches and removed Windows carriage retu…
1d74e5f 
…rns from scripts
Using stream_count variable to alter template for hls segment filenames
9127143
@abhiTronix
🐛 Fixed StreamGear Malformed URI Error with HLS Segments [PR #243 by @…
dc9c60a 
…Vboivin] (Fixed #248)

- 🎨 Removed the extra '%' character from the naming convention for segment files.
- 🎨 Removed the Windows carriage returns from the shell scripts to be able to execute them on Linux. 
- ⚡️ Used stream_count variable to alter template for hls segment filenames.
@abhiTronix
🎨 StreamGear: Updated default stream_count dict key value to 1
4493c81 
- 🔖 Bumped vidgear version to `0.2.3`.
- 💡 Updated code comments and reformatted code.
- 🔥 Setup: Removed redundant code.
@abhiTronix
👷 CI: Migrated to new Codecov Uploader in Azure Pipelines
a2331bb 
- 🗑️ Support for the Bash Uploader will be deprecated on February 1st, 2022. See: https://docs.codecov.com/docs/about-the-codecov-bash-uploader
- ⚡️ Added commands for signature and SHASUM verification to ensure integrity of the Uploader before use.
- 🎨 Replaced related bash commands.
@abhiTronix
✏️ Docs: Minor typos fixed.
fd5f77a
@abhiTronix
🐛 CI: Fixed Azure Pipeline coverage upload bugs.
ceaf15b
@abhiTronix
👷 CI: Added codecov secret token through env variable.
c76f24a 
- ✏️ Docs: Minor typos fixed
@abhiTronix
📝 Docs: Added new ScreenGear example and several typos fixed (Fixes #251
7cbc1bd 
)

- 📝 Added new ScreenGear with WebGear_RTC API bonus example.
- 🚸 Added warning for ScreenGear outputting RGBA frames instead of default BGR frames with `mss` backend.
- ✏️ Several internal and external webpage links typos fixed.
- ♿️ Updated admonitions.

CI :
- 👷 Added wildcard to skip CI tests for doc(`.md`) files.
- 👷 Added `.md` files to Codecov ignore list.
@abhiTronix
🐛 WebGear_RTC: Fixed name 'VideoStreamTrack' is not defined bug (Fixed …
3499d0f 
…#246)
@abhiTronix
💚 CI: Fix for random errors in CamGear stream_mode test.
4491df6
@abhiTronix
🐛 WriteGear: Fixed bug in disable_force_termination logic which acc…
5feafb7 
…identally disables force termination. (Fixes #259)

- ⚗️ Introduced experimental python short-circuiting for handling logging.
- 🔊 Enabled logging for `check_WriteAccess` method in WriteGear, StreamGear and NetGear.
- 💡 Improved code comments.

Helper:
- 🐛 Fixed check_WriteAccess failing to recognize correct permission for writing the output file on windows platform. (Fixes #260)
- ⚡️ Implemented separate logic for Windows and *nix platforms.
- 🥅 Improved warnings and error handling in `check_WriteAccess`.
- 💥 `check_WriteAccess` will now throw error if writing directory not present.
- 🎨 Added logging parameter to `check_WriteAccess`.
- ➕ Added `stat` import.

Docs:
- 📝 Fixed bugs in WriteGear's Compression Mode with Live Audio Input example.
- 📝 Added warnings for properly formatting output_params when assigning external audio-source in WriteGear.

CI:
- 👷 Replaced `env` with `export` in ci_linux.yml.
- 👷 Replaced `bubkoo/needs-more-info@v1` with `wow-actions/needs-more-info@v1`.
@abhiTronix
Helper: 🐛 Fixed bug in check_WriteAccess that throws OSError while …
5c2b508 
…handling URLs.

Docs:
- ✨ Added support for `hl_lines` argument for highlighting specific code lines.
- 📝 Added depreciation notice for Python 3.6 legacies.
- 🚸 Restructured docs to make it more user-friendly.
- 🎨 Updated, Extended and Improved context.
- ✏️ Fixed several typos.

WriteGear: 💡 Improved code comments.

CamGear: ⚡️ Added support for `4K` videos.

Maintenance: 🙈 Added more entries to `.gitignore` for ignoring unwanted files.
@abhiTronix
⚗️ Maintenance: Introduced experimental python short-circuiting for h…
d81371e 
…andling logging logic.
@abhiTronix
✨ Maintenance: Added .gitattributes to manage how Git reads line en…
088d90c 
…dings.

- 🚸 Enabled `auto` default behavior, in case people don't have `core.autocrlf` set.
- 🎨 Enforced LF line-endings for selective files types.
- ⚡️ Added Binary data files that specifies they are not text, and git should not try to change them.
- ♿️ Added Language aware diff headers.
- ♿️ Added Linguist language overrides.
@abhiTronix
📝 Docs: Updated changelog.md.
0085427 
- 💄 Added drop-shadow effects for slate theme to improve visibility.
- ✏️ Fixed context and typos.
- 🎨 Some minor tweaks to docs UI.
@abhiTronix
🔊 Logging: Implemented logging ColorFormatter string alignment.
45f9ac6 
- 🎨 Center aligned logging Levelname and Classname.
- ⚡️ Changed `%` formatting style with modern `{`.
- 🎨 Re-added `asctime` value to Formatter string.
- 🎨 Re-arranged parameter positions in Formatter string.

Docs:
- 🐛 Fixed "drop-shadow" property via `filter` function conflicting with sidecard button.
- 💄 Added new CSS classes for image, admonitions and code highlight in dark theme.
- 💄 Updated `changelog.md` and `custom.css`.
@abhiTronix
📝 Docs: Updated changelog.md.
0ba7718
@abhiTronix
⚡️ CamGear: Replaced youtube-dl with yt-dlp as pafy backend. (Fixes
e80e114 
#261)

- ⚡️ Implemented hack to trick pafy into assuming `yt-dlp` as `youtube-dl`.
- 🚑️ Using `sys.modules` to present `yt-dlp` as `youtube-dl`.
- ⚡️ `yt-dlp` is a youtube-dl fork based on the now inactive youtube-dlc.
- ⚡️ `yt-dlp` python API functions exactly similar to `youtube-dl`.
- ➕ Replaced `youtube-dl` dependency with `yt-dlp`.
- ➕ Replaced `youtube-dl` imports with `yt-dlp`.
- 📝 Updated docs and code comments.
@abhiTronix
📝 Docs: Updated changelog.md.
532cd7c 
- 🍱 Update vidgear's banner image.
@abhiTronix abhiTronix added BUG 🐛 Vidgear api's error, flaw or fault ENHANCEMENT ⚡ New Feature/Addition/Improvement MAINTENANCE 🏗️ Just sorting things out! WORK IN PROGRESS 🚧 currently been worked on. NEW RELEASE 🔥 New Release. Yay! DOCS 📜 Issue/PR is related to vidgear docs. labels Oct 27, 2021
@abhiTronix abhiTronix added this to the 0.2.3 milestone Oct 27, 2021
@abhiTronix abhiTronix added this to In progress PRs in VidGear v0.2.3 via automation Oct 27, 2021
@abhiTronix abhiTronix self-assigned this Oct 27, 2021
This was linked to issues Oct 27, 2021
name 'VideoStreamTrack' is not defined #246
Closed
StreamGear Malformed URI with Segments #248
Closed
ScreenGear and WebGear_RTC not working when using monitor=2 #251
Closed
Release of Vidgear v0.2.3 #254
Closed
Bug: WriteGear failed to exit with external audio source #259
Closed
Bug: Path permissions not recognised correctly in check_WriteAccess helper method #260
Closed
CamGear: Replaced Youtube-DL with yt-dlp #261
Closed
@abhiTronix abhiTronix merged commit 99ffcec into master Oct 27, 2021
VidGear v0.2.3 automation moved this from In progress PRs to Done Oct 27, 2021
@abhiTronix abhiTronix deleted the testing branch October 27, 2021 03:55
@abhiTronix abhiTronix added SOLVED 🏁 This issue/PR is resolved now. Goal Achieved! and removed WORK IN PROGRESS 🚧 currently been worked on. labels Oct 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@abhiTronix abhiTronix

Labels
BUG 🐛 Vidgear api's error, flaw or fault DOCS 📜 Issue/PR is related to vidgear docs. ENHANCEMENT ⚡ New Feature/Addition/Improvement MAINTENANCE 🏗️ Just sorting things out! NEW RELEASE 🔥 New Release. Yay! SOLVED 🏁 This issue/PR is resolved now. Goal Achieved!
Projects
No open projects
VidGear v0.2.3
Done
Milestone
0.2.3
1 participant
@abhiTronix