LemurPwned / video-sampler

Effective frame sampling for ML applications.
https://lemurpwned.github.io/video-sampler/
MIT License
16 stars 5 forks source link

Feat/output fmt #35

Closed LemurPwned closed 2 days ago

LemurPwned commented 2 days ago

Summary by Sourcery

Enhance the video sampler with a new output path formatting feature and update the CI workflow to automate release versioning.

New Features:

Enhancements:

CI:

sourcery-ai[bot] commented 2 days ago

Reviewer's Guide by Sourcery

This pull request implements changes to improve the output format of the video sampler and adds a GitHub release workflow. The main changes include modifying the output file naming convention, introducing new configuration options for save format, and setting up an automated release process in the CI/CD pipeline.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Modify output file naming convention
  • Add a new method 'format_output_path' to handle file naming
  • Implement options to encode frame time as base64
  • Add option to include video filename in the output path
  • Update the queue_reader method to use the new format_output_path function
video_sampler/sampler.py
Introduce new configuration options for save format
  • Create a new SaveFormatConfig class with 'encode_time' and 'include_filename' options
  • Add SaveFormatConfig to the SamplerConfig class
  • Update the hash_base.yaml configuration file with new save format options
video_sampler/config.py
configs/hash_base.yaml
Set up automated GitHub release process
  • Add a step to extract the version number from pyproject.toml
  • Create a new 'release' job in the CI/CD workflow
  • Use GitHub CLI to create a new release with generated release notes
.github/workflows/build.yml

Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).