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.

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

Release VidGear Stable v0.2.6 #321

Merged
merged 56 commits into from Jul 5, 2022
Merged

Release VidGear Stable v0.2.6 #321

merged 56 commits into from Jul 5, 2022

Conversation

abhiTronix
Copy link
Owner

@abhiTronix abhiTronix commented Jul 5, 2022

Brief Description

New vidgear stable release is here with focus on bugfixes and improvements to user-experience. πŸŽ‰

Key Changes:

πŸ““ Complete Release Notes can be found here ↗️

New Features ✨

  • Docs:
    • Added new bonus example for RSTP/RTP Live-Streaming using WriteGear's Compression Mode.
    • Added "How to resolve zmq.error.ZMQError" FAQ for NetGear API.(PR by @iandol)
  • Maintenance:
    • Added new patterns to .gitignore to ignore pypi's build directory and egg-info files.
  • CI:
    • Switched to new Issue GitHub's form schema using YAMLs.

Updates/Improvements ⚑️

  • Setup.py:
    • Replaced >= comparsion operator with more flexible ~=.
    • Replaced distutils.version.LooseVersion with pkg_resources.parse_version.
  • Docs:
    • Updated Site Navigation.
      • Added new notices to inform users more effectively about bonus examples.
      • Added new Bonus section to navigation and moved suitable pages under it.
    • Redesigned and Rewritten Donation and Contribution section to README.md
    • Updated Zenodo badge and bibtex entry.
  • API:
  • CI:
    • Added more paths and files to skip commits.

Breaking Updates/Changes πŸ’₯

  • -input_framerate parameter now accepts any positive value for WriteGear and StreamGear APIs.

Bug-fixes πŸ›

  • API: Fixed -input_framerate less than 5 does not get used in WriteGear and StreamGear APIs.(PR by @freol35241)
  • CamGear: Fixed Yt-dlp generated HTTP DASH Segments URLs not supported by OpenCV's VideoCapture(PR by @DynamiteC)
  • StreamGear:
    • Fixed hls_segment_type not working bug. (PR by @enarche-ahn)
    • Fixed critical logging parameter bug
      • Fixed debug logs even when logging=False in StreamGear's Real-time Mode. (patch suggested by @enarche-ahn)
      • Added length check to -video_source attribute to correctly infers it as empty(or invalid).
  • CI:
    • Xfailed RSTP CamGear CI test.
    • Fixed pinned version syntax bug in docs_deployer workflow.
    • Fixed typos in Github forms and its context.
    • Added missing dependency.
  • Docs:
    • Fixed jinja2 3.1.0 or above breaks mkdocs.
    • Fixed support for new mkdocstring versions
      • Replaced rendering sub-value with options.
      • Removed pinned mkdocstrings==0.17.0 version.
    • Fixed Netgear+Webgear bonus example code bugs.(PR by @iandol)
      • Added a missing import.
      • Removed self. typo.
      • Replaced the return value with break in the async as it triggers an error.
    • Fixed external bug that causing "Home" tab to irresponsive randomly when accessed from other tabs.

Requirements / Checklist

Related Issue

#289
#291
#294
#306
#314
#318
#319

Context

VidGear's next milestone release i.e. v0.2.6 brings bugfixes and lots of under the hood improvements.

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 30 commits February 11, 2022 20:35
…enarche-ahn)

Bug: I changed the hls_segment_type option to 'fmp4', but it doesn't work. The reason is that hls_segment_type is a 'str' type, but it is checked as 'int', so it is always set to the default type 'mpegts'.
- πŸ› Fixed debug logs even when `logging=False` in StreamGear's Real-time Mode. (patch suggested by @enarche-ahn)
- 🎨 Added length check to `"-video_source"` attribute to correctly infers it as empty(or invalid).
- πŸ’‘ Updated code comments.

✏️ Docs: Fixed typos in formatting.
- 🎨 Added new patterns to `.gitignore` to ignore pypi's `build` directory and `egg-info` files.
- 🎨 `tostring` was renamed to `tobytes` for the purposes for clarity in Python 3.2. https://docs.python.org/3/library/array.html#array.array.tobytes
- πŸ› Fixed debug logs even when `logging=False` in StreamGear's Real-time Mode. (patch suggested by @enarche-ahn)
- 🎨 Added length check to `"-video_source"` attribute to correctly infers it as empty(or invalid).

Docs: 
- πŸ“ Updated Zenodo badge and bibtex entry.
- ✏️ Fixed typos in formatting.
- πŸ’‘ Updated code comments.

Maintenance: 
- πŸ™ˆ Added new patterns to `.gitignore` to ignore pypi's `build` directory and `egg-info` files.
- πŸ—οΈ Updated depreciated tostring() to tobytes(). `tostring` was renamed to `tobytes` for the purposes for clarity in Python 3.2. https://docs.python.org/3/library/array.html#array.array.tobytes
Added a section to the FAQ detailing a possible error if a user uses the server IP in the example code.
I made 3 changes: (1) added a missing import (2) removed `self.` typo (3) removed the return value in the async as it triggers an error .
Use break instead of return. Also correct a small typo (missing space) between word and bracket.
πŸ“ Made 3 changes: 
- (1) added a missing import.
- (2) removed `self.` typo 
- (3) replaced the `return` value with `break` in the async as it triggers an error .
… [PR by @freol35241]

- πŸ”§ Removed 5 second threshold in WriteGear and StreamGear APIs.
- πŸ‘· Xfailed RSTP CamGear CI test.
…. [PR #313]  (Fixes #314)

- Fixes Youtube-dl generated HTTP DASH Segments URLs not supported by OpenCV's VideoCapture(Patch by @DynamiteC)
jinja2 >=3.1.0 breaks mkdocs (mkdocs/mkdocs#2799), therefore fixing jinja2 version to <3.1.0.
- πŸ“ Replaced rendering sub-value with options.
- ♻️ Removed pinned `mkdocstrings==0.17.0` version.
- ✨ Added `deduplicate-toc` plugin.
- 🚸 Added new notices to inform users more effectively about bonus examples.
- ✨ Added new `Bonus` section to navigation and moved suitable pages under it.
- πŸ“ Updated headings and URLs.
- ✏️ Fixed typos and updated contexts.
- πŸ”₯ Removed unused docs.
- ✨ Added new `proposal.yaml`
- πŸ”₯ Deleted `proposal.md`
…ixed #319)

- ✨ Added new `bug_report.yaml`
- ✨ Added new `question.yaml`
- ✨ Added new `proposal.yaml`
- πŸ”₯ Deleted `bug_report.md`
- πŸ”₯ Deleted `question.md`
- πŸ”₯ Deleted `proposal.md`
- 🎨 Polished forms.
- ✏️ Fixed typos in forms and its context.
- ✨ Added feedback link to the Announcement Block for our new DeFFcode library.
- πŸ’„ Added and tweaked new glowing text effect with CSS properties.
- ✏️ Fixed typos and rewritten some docs.
- πŸ’‘ Added comments to CSS file.
- Bug fix has been released as part of new version `8.3.9`.
@abhiTronix abhiTronix added BUG πŸ› Vidgear api's error, flaw or fault ENHANCEMENT ⚑ New Feature/Addition/Improvement WORK IN PROGRESS 🚧 currently been worked on. NEW RELEASE πŸ”₯ New Release. Yay! DOCS πŸ“œ Issue/PR is related to vidgear docs. labels Jul 5, 2022
@abhiTronix abhiTronix added this to the 0.2.6 milestone Jul 5, 2022
@abhiTronix abhiTronix self-assigned this Jul 5, 2022
@abhiTronix abhiTronix added this to In progress in VidGear v0.2.6 via automation Jul 5, 2022
@codecov
Copy link

codecov bot commented Jul 5, 2022

Codecov Report

Merging #321 (4898ddd) into master (6af7aef) will increase coverage by 5.88%.
The diff coverage is 95.67%.

@@            Coverage Diff             @@
##           master     #321      +/-   ##
==========================================
+ Coverage   86.43%   92.32%   +5.88%     
==========================================
  Files          16       16              
  Lines        3074     3074              
==========================================
+ Hits         2657     2838     +181     
+ Misses        417      236     -181     
Impacted Files Coverage Ξ”
vidgear/version.py 100.00% <ΓΈ> (ΓΈ)
vidgear/gears/camgear.py 95.56% <95.56%> (+1.47%) ⬆️
vidgear/gears/streamgear.py 96.64% <100.00%> (ΓΈ)
vidgear/gears/writegear.py 94.29% <100.00%> (ΓΈ)
vidgear/gears/helper.py 77.58% <0.00%> (-10.57%) ⬇️
vidgear/gears/asyncio/netgear_async.py 89.31% <0.00%> (ΓΈ)
vidgear/gears/netgear.py 93.63% <0.00%> (+0.74%) ⬆️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Ξ” = absolute <relative> (impact), ΓΈ = not affected, ? = missing data
Powered by Codecov. Last update 6af7aef...4898ddd. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment