✨ [v0.2.2] Major Docs and API updates #23
Merged
Conversation
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
- ➕ Added new `mkdocstrings-python-legacy` dependency. - 📝 Replaced `rendering` variable with `options`. - ♻️ Removed pinned `mkdocstrings==0.17.0` version. - ⚰️ Removed redundant variables.
- 🚸 Updated text font to `Heebo`. - 🧑💻 Updated code font to `JetBrains Mono`.
- 🚸 Updated primary light color to `light green`. - 🚸 Updated primary dark color to `amber`. - 💄 Updated accent light color to `green`. - 💄 Updated accent dark color to `lime`.
- 📝 Rewritten introductory Sourcer class description. - 🎨 Moved docs block from `index.md` to class description. - 🚸 Fixed missing class and methods parameter description. - ✏️ Fixed typos and context. - 💡 Reformatted code comments. - 📦️ Optimized imports. - 💥 Breaking Changes: - 🏗️ Updated `retrieve_metadata()` to return parsed metadata as JSON string or dictionary type. - ✨ Added new `pretty_json` boolean parameter to `retrieve_metadata()`, when `True` return metadata formatted as JSON string instead of default python dictionary. Docs: - 📝 Rewritten and Renamed "Generate Source Video Metadata" example w.r.t breaking changes in Sourcer API. - 📝 Updated example context and code. - 💄 Updated admonitions. FFdecoder: - 🎨 Fixed missing and improper class parameter description.
- 📝 Rewritten introductory FFdecoder class description. - 🎨 Moved docs block from `index.md` to class description. - 🚸 Reformatted methods description. - ✏️ Fixed typos and context. Docs: - ⚰️ Deleted dead code. Sourcer: - 🎨 Reformatted class and methods description.
- 🚸 Rewritten index.md with new information and redefined context. - 📝 Added new blocks like Installation, Quickstart, Usage Examples and API in a nutshell. - 💄 Added new experimental dark and light theme logo support in deffcode docs and README.md. - 🍱 Added dark logo `deffcode-dark.png` asset. - 🔥 Removed tag-line from README.md and related asset. - 🎨 Updated class descriptions. - 🔥 Removed old docs. - ✏️ Fixed typos.
- 🏗️ Updated Site Navigation and Tab titles in mkdocs.yml - ✨ Added `navigation.tabs` feature. - 🎨 Reformatted `index.md` and `installation/index.md`. - 🚚 Renamed `help/index.md` to `help/help.md`. - 🍱 Updated icons in headings. - ✏️ Fixed typos and contexts.
- 📝 Rewritten README.md with more recent information and redefined context. - 🎨 Rewritten and Reformatted DeFFcode Abstract and Centered introduction. - 🚸 Simplified and Reformatted "Get Started"section w.r.t new `index.md`. - 🚚 Imported new "Contributions" and "Donations" sections from VidGear docs. - 💄 Added experimental note blockquote from GitHub to simulate admonition. - 💄 Added collapsible terminal output section using `<summary>` and `<detail>` tags. - 🚸 Simplified and Grouped README URL links. - 📝 Updated Key Features. - 🔥 Removed Roadmap section. - 🎨 Reformatted and centered introductory text in `index.md`. - 📝 Added more Key Features and removed redundant information. - ✨ Added custom `spacer` class in CSS for custom vertical spacing. - 🚸 Updated spacing in `index.md` using `spacer` class within `<div>` tag and ` `. - 🏗️ Moved basic and advanced recipes from `example` to `recipes` folder. - 🎨 Updated navigation in `mkdocs.yml`. - 🏗️ Moved `help.md` one directory up. - 🚚 Imported "Donations" sections from VidGear docs to `help.md`. - 🎨 Updated internal URL links in docs. - ✏️ Fixed text context and more typos.
- 🚚 Imported new admonitions: "New", "Advance", "Alert" from vidgear. - 💄 Updated all admonitions icons using custom icon SVG URLs. - 🚸 Reformatted `custom.css` and added missing comments. - ✏️ Fixed typos.
- ✨ Added new Functional Block Diagrams to FFdecoder and Sourcer API References. - 🍱 Added two new image assets: `ffdecoder.png` and `sourcer.png`. - 📝 Added new abstracts to FFhelper and Utils docs. - 🚸 Reformatted FFmpeg Installation doc and Issue & PR guidelines, also added missing information. - 🚸 Updated static FFmpeg binaries download URLs. - 🐛 Fixed some admonitions icons not showing bug using `!important` rule in CSS. - ♿️ Replaced appropriate admonitions. - 💄 Changed "Danger" and "Bug" icons. - 💄 Changed "Alert" admonition background colors. - 🐛 Fixed invalid internal Hyperlink URLs and image paths. - ✏️ Fixed icons, typos and descriptions.
- ✏️ Fixed small typos.
- 🐛 Fixed Sourcer API throws IOError for videos containing streams without both video bitrate and framerate defined such as from `lavfi` input virtual device. - 🏗️ Implemented new checks to ensure given input `source` has usable video stream available by checking `video bitrate` or both `frame-size` and `framerate`_ in video's metadata. - ⚡️ Improved extract_resolution_framerate method to make video framerate extraction more robust by falling back to extracting TBR value on failure instead, since it is FFmpeg's best guess as to what the framerate actually is. - ✨ Added support for `-ffprefixes` attribute through `sourcer_param` dictionary parameter (similar to FFdecoder API). - 💥 Changed `IOError` to `ValueError`, raised when source with no decodable audio or video stream provided. - 💡 Updated description and code comments.
- ✨ Added new `output_frames_pixfmt` metadata attribute to handle output frames pixel format. - ⚡️ Implemented logic to check and use manually specified `output_frames_pixfmt` metadata attribute prior to default `rbg24` or source pixel-format, when `frame_format` value is Nonetype. - 🩺 Updated checks to sanitize `output_frames_pixfmt` metadata attribute before using as default pixel-format. - ✨ Added new user_metadata internal class dictionary variable to handle only user-defined metadata information (`metadata` property object now returns User-defined metadata merged with video's metadata) - 💥 `source` metadata value cannot be altered through `metadata` property object. - 🩺 Updated `metadata` property object in FFdecoder API to validate video metadata attributes against original datatypes, and also handle user-defined metadata separately. - 🩺 Implemented logic to validate manually specified `source_video_resolution` metadata attribute to control frame-size through metadata. - ⚡️ Improved logic to test validity of `-custom_resolution` attribute value. - 💥 FFdecoder will throw `RuntimeError` if `source_video_resolution` metadata value is invalid and `-custom_resolution` attribute value not defined. - 💥 Removed `-ffpostfixes` attribute support from `ffparams` dictionary parameter, since it's redundant in favor of similar `-ffprefixes` and `-clones` attributes. - 🐛 Added tuple to exception in datatype check for `ffparams` dictionary parameter. - 🔊 Added new and updated logging messages to notify invalid datatype values. - 🩺 Added datatype check for `frame_format` parameter. - 💬 Updated `passthrough_mode` to TODO comment tag. - 💡 Updated description and code comments.
- 💄 Updated admonition icons with new SVG+XML URLs. - 💄 Updated "alert" admonition background and foreground RGB colors. - 🐛 Fixed some admonitions icons not showing bug using `!important` rule in CSS. - 🔥 Removed `quote/cite/summary` admonition UI patches.
- ✅ Updated `test_frame_format` unittest to include manually assign output pixel-format via `metadata` property object - 👷 Updated `test_metadata` unittest to include new `checks` parameter to decide whether to perform Assertion test on assigned `metadata` properties. - 👷 Added new `parametrize` attributes in `test_metadata` and `test_seek_n_save` unittests to cover every use-cases. - ✅ Replaced `IOError` with `ValueError` in Sourcer unittests.
- ✨ Added two new `index.md` markdowns to introduce basic and advanced recipes with self-explanatory text, curated hyperlinks to various recipes(separated with categories), and related GIFs. - 🏗️ Added two new folders to hold basic and advanced recipes separately. - 🚸 Added related tips, warning, etc. admonitions and other relevant information required for these recipes. - 💄 Revamped DeFFcode Introduction `index.md` with new Information, Context and UI changes, Updated example codes and hyperlinks, and fixed typos. - 📝 Updated Announcement Bar to fix `announcement_link` variable and text. - 🔥 Removed redundant `advanced.md` and `basic.md` docs.
- ✨ Added new markdown files with self-explanatory Basic Decoding Recipes, related usage code, and UI upgrades for bringing standard and quality to visual design. - 📝 Added Decoding Video files with various pixel formats recipes. - 📝 Added Decoding Live Feed Devices recipes with source_demuxer. - 📝 Added Decoding Image sequences recipes supporting Sequential, Glob pattern , Single (looping) image. - 📝 Added Decoding Network Streams recipes. - 🚸 Added new admonitions to specify python dependencies required by each recipes as well as other requirements, warnings when using these recipes. - ✏️ Fixed several typos and context.
- ✨ Added new markdown files with self-explanatory Basic Transcoding Recipes, related usage code, and UI upgrades for bringing standard and quality to visual design. - 📝 Added Transcoding Live frames recipes with OpenCV and WriteGear. - 📝 Added Transcoding Live Simple Filtergraphs recipes with OpenCV. - 📝 Added Saving Key-frames as Image recipes with different image processing libraries. - 🍱 Added new related GIFs (into new `gifs` folder) and images assets. - 🚸 Added new admonitions to specify python dependencies required by each recipes as well as other requirements, warnings when using these recipes. - ✏️ Fixed several typos and context.
- ✨ Added new markdown file with self-explanatory Basic Decoding Recipes, related usage code, and UI upgrades for bringing standard and quality to visual design. - 📝 Added Extracting Video Metadata recipes with FFdecoder and Sourcer APIs. - 🚸 Added new admonitions to specify python dependencies required by each recipes as well as other requirements, warnings when using these recipes.
- 🚸 Rewritten and Refashioned FFdecoder API's parameter reference docs with new information w.r.t recent changes. - 🚸 Rewritten and Refashioned Sourcer API's parameter reference docs with new information w.r.t recent changes. - 📝 Added multiple new admonitions explaining new changes, related warnings/errors, usage examples etc. - ✏️ Fixed usage code, several typos, comments, and contexts.
abhiTronix
added
Documentation 📑
This was
linked to
issues
Aug 7, 2022
Closed
Closed
- 🚑️ Fixed metadata property object unable to process user-defined keys when any source metadata keys are defined. - ⚡️ Improved handling of source metadata keys in metadata property object. - ⚡️ Simplified `for` loop with `if` condition checking in metadata property object. - 🔊 Added `tuple` value warning log to notify users `json` module converts Python `tuples` to JSON `lists`. ✅ CI: Updated `test_metadata` unittest to test `tuple` value warning. 🚸 Docs: Updated footer note to notify users regarding `tuple` value warning and other minor fixes.
Codecov Report
@@ Coverage Diff @@
## master #23 +/- ##
==========================================
+ Coverage 96.08% 97.24% +1.15%
==========================================
Files 6 6
Lines 587 616 +29
==========================================
+ Hits 564 599 +35
+ Misses 23 17 -6
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
- 👷 Updated unittests to increase code coverage significantly. 🧑💻 Sourcer: Simplified `if-else` logic to one liner.
- 🐛 Fixed TypeError bug with string type `-framerate` parameter value. - ⚡️ Implemented accurate handling of FFmpeg pipeline framerate with both user-defined and metadata defined values. 🔊 Maintenance: Updated logging comments.
- ⚡️ Minor changes to Updating Video Metadata doc text context and admonitions. - ✏️ Fixed several typos.
abhiTronix
added
Solved 🥅
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Complete docs overhaul with many new self-explanatory Recipes, new usage code, and UI upgrades for bringing standard and quality to visual design. Also includes several bug fixes, and new additions to APIs.
Requirements / Checklist
Related Issue
#18
#19
#22
Types of changes
Miscellaneous (if available):
Docs changes can be viewed here: https://abhitronix.github.io/deffcode/v0.2.2-dev/