🎉 Release VidGear Stable v0.3.2

[abhiTronix]

Brief Description

New vidgear stable release is here that introduces several enhancements, updates, and bug fixes to the codebase.🎉

Changes:

This PR includes a series of updates and improvements to different parts of the project:

New Features ✨

• NetGear:
  • Added new kill parameter to close() method to forcefully kill ZMQ context instead of graceful exit only in the receive mode.
  • Added new subscriber_timeout integer optional parameter to support timeout with pattern=2 (or Publisher-Subscriber) pattern.
    • Receiver will exit safely if timeout defined(any value(in milliseconds) > 0), and timeout occurs in Receiver Mode with pattern=2.
    • 💬 Note: Default behavior still is to block the thread till infinite time.
• WriteGear:
  • Added new -disable_ffmpeg_window optional Boolean flag to enable patch that prevents FFmpeg creation window from opening when building .exe files on Windows OS. (PR by @ibtsam3301)
    • 💬 Note: -disable_ffmpeg_window optional Boolean flag is only available on Windows OS with logging disabled(logging=False) in compression mode.
    • Use Case: This flag can be useful while creating an .exe file for a python script that uses WriteGear API. On windows even after creating the .exe file in windowed mode or no-console mode, the ffmpeg.exe command line window would pop up while its being used by WriteGear API.
• Setup.py
  • Added official support for python 3.11.x legacies.
  • Bumped version to 0.3.1.
• Docs
  • Added doc for subscriber_timeout optional Integer parameter in NetGear.
  • Added doc for disable_ffmpeg_window optional Boolean parameter in WriteGear.
  • Added new asset screengear_region.png.
• CI
  • Added python 3.11 legacy support for MacOS, Windows and Linux environments.
  • Added kill argument to close() method in various NetGear tests.

Updates/Improvements ⚡️

• Asyncio:
  • Formatted TemplateResponse class parameters w.r.t new changes in backend Starlette API.
• Setup.py:
  • Readded latest patch to uvicorn, starlette, pyzmq dependencies.
  • Removed 3.7 legacy from Programming Language metadata.
• Maintenance:
  • Added GitHub sponsors and dropped liberapay from Funding.yml.
  • Removed redundant code.
• Docs:
  • Updated information related to Supported Dimensional Attributes in ScreenGear docs.
  • Updated minimum python to version 3.8 while installing vidgear in docs.
  • Updated API-specific dependencies in docs.
  • Updated changelog.md
• CI:
  • Updated Azure Pipeline workflow.
  • Updated Appveyor Pipeline workflow.
  • Updated GitHub Actions Pipeline workflow.
  • Migrated python version to 3.9 in deploy_docs.yml workflow.
  • Removed deprecated python 3.7 legacy support.
  • Increased code coverage by updating tests.
  • Updated tests for subscriber_timeout optional Integer parameter in NetGear.
  • Updated tests for disable_ffmpeg_window optional Boolean parameter in WriteGear.

Breaking Updates/Changes 💥

• Setup.py:
  • Removed support for python-3.7 legacies
    • Raised python_requires to >=3.8. Thereby python 3.7 and any before legacy are no longer supported.

Bug-fixes 🐛

• ScreenGear:
  • Fixed swapped region dimensions bug with dxcam backend.
  • Fixed "mss" backend disabled when monitor parameter is not defined.
• Docs:
  • Fixed missing compression_mode flags in WriteGear API docs.
  • Fixed missing hyperlinks.
  • Fixed typos and context.
• CI:
  • Temporary fix for AST constructor depth mismatch in pytest on python 3.11.x, More information: Occasional AST constructor depth mismatch pytest-dev/pytest#10874
    • Made temporary fix platform independent.
    • Extended fix to all Webgear_RTC tests.
  • Fixed NetGear tests bugs.
  • Fixed condition logic bug.

Requirements / Checklist

• I have read the PR Guidelines.
• I have read the Documentation.
• I have updated the documentation accordingly(if required).

Related Issue

#369
#316
#359
#360
#362

Context

VidGear's next milestone release i.e. v0.3.2 with changes that are required to enhance the library's functionality, improve user experience, address issues and bugs, ensure compatibility with the latest Python version, and maintain the overall quality and reliability of the codebase. They make the library more robust and user-friendly, benefiting both current and future users of the software.

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)

Screenshots (if available):

https://abhitronix.github.io/vidgear/v0.3.2-dev/

[codecov]

Codecov Report

Patch coverage is 97.61% of modified lines.

Files Changed	Coverage
vidgear/gears/asyncio/webgear.py	ø
vidgear/gears/camgear.py	ø
vidgear/gears/streamgear.py	ø
vidgear/gears/asyncio/webgear_rtc.py	66.66%
vidgear/gears/netgear.py	100.00%
vidgear/gears/screengear.py	100.00%
vidgear/gears/stabilizer.py	100.00%
vidgear/gears/writegear.py	100.00%
vidgear/version.py	100.00%

📢 Thoughts on this report? Let us know!.