🔖Released VidGear Stable v0.2.6 [#321]

📓 Complete Release Notes: https://abhitronix.github.io/vidgear/latest/changelog/#v026-2022-07-05

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:
    * Updated depreciated `tostring()` to `tobytes()` for the purposes for clarity in Python 3.2. https://docs.python.org/3/library/array.html#array.array.tobytes
- 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.
        + `jinja2>=3.1.0` breaks mkdocs (mkdocs/mkdocs#2799), therefore pinned jinja2 version to `<3.1.0`.
    * 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.

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,92 @@
+name: Bug Report
+description: File a bug report for VidGear 🐛
+title: "[Bug]: "
+labels: ["BUG :bug:", "NEED TRIAGE :police_car:"]
+assignees:
+  - abhiTronix
+body:
+  - type: textarea
+    attributes:
+      label: Description
+      description: Please provide a brief description of the bug in 1-2 sentences.
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Issue Checklist
+      description: "By posting this issue you acknowledge the following:"
+      options:
+        - label: I have searched open or closed [issues](https://github.com/abhiTronix/vidgear/issues) for my problem and found nothing related or helpful.
+          required: true
+        - label: I have read the [Documentation](https://abhitronix.github.io/vidgear/latest) and found nothing related to my problem.
+          required: true
+        - label: I've read the [Issue Guidelines](https://abhitronix.github.io/vidgear/latest/contribution/issue/#submitting-an-issue-guidelines) and wholeheartedly agree.
+          required: true
+  - type: textarea
+    attributes:
+      label: Expected behaviour
+      description: Please describe precisely what you'd expect to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Actual behaviour
+      description: Please describe precisely what is actually happening, and why you consider it to be a bug?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: Please describe the steps to reproduce the bug.
+      placeholder: |-
+        1. ...
+        2. ...
+        3. ...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Terminal log output
+      description: Please copy and paste any relevant terminal log output to help quickly debug bugs. You can enable logging with `logging=True` in any Vidgear API for getting verbose terminal logs.
+      render: shell
+  - type: textarea
+    attributes:
+      label: Python Code
+      description: Share python code you're using(only if available) here or else leave this block empty. You can directly paste your python code here, no need for any backticks or formatting.
+      render: python
+  - type: input
+    attributes:
+      label: VidGear Version
+      description: What version of VidGear are you running? Run command `python -c "import vidgear; print(vidgear.__version__)"` to find out.
+      placeholder: ex. 0.2.6
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Python version
+      description: What version of Python you're running Vidgear on? Run command `python -V`  to find out.
+      placeholder: ex. 3.7
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: OpenCV version
+      description: What version of OpenCV binaries you're running? Run command `python -c "import cv2; print(cv2.__version__)"` to find out.
+      placeholder: ex. 4.6.0.66
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Operating System version
+      description: What Operating system you're using?
+      placeholder: ex. Linux Mint 20.3 Cinnamon
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Any other Relevant Information?
+      description: Provide any other relevant information if available or else leave this block empty. If applicable, you can also drag-and-drop mockups or screenshots images here, or link to external assets.
+      placeholder: |-
+        ex. Related Issue: xyz/foo#4083
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/proposal.yaml

@@ -0,0 +1,43 @@
+name: Proposal
+description: Suggest an idea for improving VidGear 💡
+title: "[Proposal]: "
+labels: "PROPOSAL :envelope_with_arrow:"
+body:
+  - type: checkboxes
+    attributes:
+      label: Issue guidelines
+      description: Please read the Issue guidelines before proceeding.
+      options:
+        - label: I've read the [Issue Guidelines](https://abhitronix.github.io/vidgear/latest/contribution/issue/#submitting-an-issue-guidelines) and wholeheartedly agree.
+          required: true
+  - type: checkboxes
+    attributes:
+      label: Issue Checklist
+      description: "By posting this issue you acknowledge the following:"
+      options:
+        - label: I have searched open or closed [issues](https://github.com/abhiTronix/vidgear/issues) and found nothing related to my idea.
+          required: true
+        - label: I have read the [Documentation](https://abhitronix.github.io/vidgear/latest) and it doesn't mention anything about my idea.
+          required: true
+        - label: To my best knowledge, my idea wouldn't break something for other users.
+          required: true
+  - type: textarea
+    attributes:
+      label: Describe your Idea
+      description: Please describe your Idea thoroughly here. Will this change the existing VidGear APIs? How?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Use Cases
+      description: Please describe how would you use it? How can it benefit other users?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Any other Relevant Information?
+      description: Provide any other relevant information if available or else leave this block empty. If applicable, you can also drag-and-drop mockups or screenshots images here, or link to external assets.
+      placeholder: |-
+        ex. Related Issue: xyz/foo#4083
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/question.yaml

@@ -0,0 +1,58 @@
+name: Question
+description: Have any questions regarding VidGear?
+title: "[Question]: "
+labels: "QUESTION :question:"
+body:
+  - type: checkboxes
+    attributes:
+      label: Issue guidelines
+      description: Please read the Issue guidelines before proceeding.
+      options:
+        - label: I've read the [Issue Guidelines](https://abhitronix.github.io/vidgear/latest/contribution/issue/#submitting-an-issue-guidelines) and wholeheartedly agree.
+          required: true
+  - type: checkboxes
+    attributes:
+      label: Issue Checklist
+      description: "By posting this issue you acknowledge the following:"
+      options:
+        - label: I have searched open or closed [issues](https://github.com/abhiTronix/vidgear/issues) for my problem and found nothing related or helpful.
+          required: true
+        - label: I have read the [Documentation](https://abhitronix.github.io/vidgear/latest) and found nothing related to my problem.
+          required: true
+        - label: I have gone through the [Bonus Examples](https://abhitronix.github.io/vidgear/latest/help/get_help/#bonus-examples) and [FAQs](https://abhitronix.github.io/vidgear/latest/help/get_help/#frequently-asked-questions) and found nothing related or helpful.
+          required: true
+  - type: textarea
+    attributes:
+      label: Describe your Question
+      description: Please describe your question thoroughly here. What are you trying to accomplish?
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: VidGear Version
+      description: What version of VidGear are you running? Run command `python -c "import vidgear; print(vidgear.__version__)"` to find out.
+      placeholder: ex. 0.2.6
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Python version
+      description: What version of Python you're running Vidgear on? Run command `python -V`  to find out.
+      placeholder: ex. 3.7
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Operating System version
+      description: What Operating system you're using?
+      placeholder: ex. Linux Mint 20.3 Cinnamon
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Any other Relevant Information?
+      description: Provide any other relevant information if available or else leave this block empty. If applicable, you can also drag-and-drop mockups or screenshots images here, or link to external assets.
+      placeholder: |-
+        ex. Related Issue: xyz/foo#4083
+    validations:
+      required: false

.github/workflows/ci_linux.yml

@@ -20,13 +20,18 @@ on:
       - testing
     paths-ignore:
       - '**/*.md'
-      - 'docs/**'
+      - '**/*.html'
+      - '**/*.js'
+      - '**/*.css'
+      - 'docs/**/*'
+      - README.md
+      - mkdocs.yml
   pull_request:
     branches:
       - testing
     paths-ignore:
       - '**/*.md'
-      - 'docs/**'
+      - 'docs/**/*'
 
 jobs:
   test:

.github/workflows/deploy_docs.yml

@@ -47,8 +47,8 @@ jobs:
         if: success()
       - name: install_dependencies
         run: |
-          pip install -U mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin mkdocs-exclude mike
-          pip install mkdocstrings==0.17.0
+          pip install -U mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin mkdocs-exclude mike mkdocstrings mkdocstrings-python-legacy          
+          pip install jinja2==3.0.*
         if: success()
       - name: git configure
         run: |
@@ -88,8 +88,8 @@ jobs:
         if: success()
       - name: install_dependencies
         run: |
-          pip install -U mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin mkdocs-exclude mike
-          pip install mkdocstrings==0.17.0
+          pip install -U mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin mkdocs-exclude mike mkdocstrings mkdocstrings-python-legacy
+          pip install jinja2==3.0.*
         if: success()
       - name: git configure
         run: |
@@ -132,8 +132,8 @@ jobs:
         if: success()
       - name: install_dependencies
         run: |
-          pip install -U mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin mkdocs-exclude mike
-          pip install mkdocstrings==0.17.0
+          pip install -U mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin mkdocs-exclude mike mkdocstrings mkdocstrings-python-legacy          
+          pip install jinja2==3.0.*
         if: success()
       - name: git configure
         run: |