-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ Released DeFFcode Stable v0.2.3 [#26]
### ✨ New Features - Docs: * Added Zenodo Bibtex entry and badge in docs for easier citation. * Added new `<div>` tag bounding-box style to the Static FFmpeg binary download links in FFmpeg Installation Doc for better accessibility. - Maintenance: * Switched to new Issue GitHub's form schema using YAML: * Added new `bug_report.yaml` Issue GitHub's form schema for Bug Reports. * Added new `idea.yaml` Issue GitHub's form schema for new Ideas. * Added new `question.yaml` Issue GitHub's form schema for Questions. * Deleted old depreciated markdown(`.md`) files. * Polished forms. ### ⚡️ Updates/Improvements - Maintenance: * Added new patterns to `.gitignore` to ignore vim files. - CI: * Updated `test_FFdecoder_params` unittest to include `with` statement access method. - Setup: * Added new patches for using README.md text as `long_description` metadata. * Implemented new patch to remove GitHub README UI specific text. * Simplified multiple `str.replace` to chained `str.replace` of better readability. * Bumped version to `0.2.3`. - Docs: * Updated recipes to include `with` statement access method. * Updated existing recipes to include `with` statement access method in FFdecoder APIs. * Included new example code of accessing RGB frames using `with` statement access method. * Updated Recipe title to "Accessing RGB frames from a video file" across docs. * Included warning admonition for advising users to always use `trim` with `reverse` filter. * Updated docs text font to `Libre Franklin`. * Updated method description texts and logging messages. * Update icons and admonition messages. * Updated code comments. * Updated `changelog.md`. ### 🐛 Bug-fixes - FFdecoder API: * Fixed Context Manager methods. * Fixed `__enter__` method returning class instance instead of formulating pipeline. * Fixed `__exit__` method calling wrong non-existent method. - Setup: * Fixed missing `comma(,)` in keywords metadata. * Fixed bug in patch string. - Docs: * Fixed typos in code comments. * Fixed several typos in docs.
- Loading branch information
Showing
24 changed files
with
496 additions
and
231 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
name: Bug Report | ||
description: File a bug-report for DeFFcode APIs 🐞 | ||
title: "[Bug]: " | ||
labels: ["Bug :lady_beetle:", "Needs Triage :monocle_face:"] | ||
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/deffcode/issues) for my problem and found nothing related or helpful. | ||
required: true | ||
- label: I have read the [Documentation](https://abhitronix.github.io/deffcode/latest) and found nothing related to my problem. | ||
required: true | ||
- label: I've read the [Issue Guidelines](https://abhitronix.github.io/deffcode/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 verbose flag with `verbose=True` in any DeFFcode API for getting verbose terminal logs. | ||
render: shell | ||
- type: textarea | ||
attributes: | ||
label: Python Code(Optional) | ||
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: DeFFcode Version | ||
description: What version of DeFFcode are you running? Run command `python -c "import deffcode; print(deffcode.__version__)"` to find out. | ||
placeholder: ex. 0.2.3 | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Python version | ||
description: What version of Python you're running DeFFcode 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
name: Idea | ||
description: Suggest an idea for improving DeFFcode 💡 | ||
title: "[Idea]: " | ||
labels: "Idea :bulb:" | ||
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/deffcode/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/deffcode/issues) and found nothing related to my idea. | ||
required: true | ||
- label: I have read the [Documentation](https://abhitronix.github.io/deffcode/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 DeFFcode 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 |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
name: Question | ||
description: Have any questions regarding DeFFcode APIs ❔ | ||
title: "[Question]: " | ||
labels: "Question :grey_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/deffcode/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/deffcode/issues) for my problem and found nothing related or helpful. | ||
required: true | ||
- label: I have read the [Documentation](https://abhitronix.github.io/deffcode/latest) and found nothing related to my problem. | ||
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: textarea | ||
attributes: | ||
label: Terminal log output(Optional) | ||
description: Copy and paste any relevant terminal log output(only if applicable) here or else leave this block empty. You can enable verbose flag with `verbose=True` in any DeFFcode API for getting verbose terminal logs. | ||
render: shell | ||
- type: textarea | ||
attributes: | ||
label: Python Code(Optional) | ||
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: DeFFcode Version | ||
description: What version of DeFFcode are you running? Run command `python -c "import deffcode; print(deffcode.__version__)"` to find out. | ||
placeholder: ex. 0.2.3 | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Python version | ||
description: What version of Python you're running DeFFcode 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -127,3 +127,7 @@ dmypy.json | |
|
||
# Pyre type checker | ||
.pyre/ | ||
|
||
# vim temporary files | ||
*~ | ||
.*.sw? |
Oops, something went wrong.