Whisper-TikTok Release v2.0.4 @ patch#50
Conversation
Co-authored-by: Simone Flavio <smoxy@users.noreply.github.com>
single_word_cc - blur_cc - fixed_audio_duration
… deploy also on dev branch
…ent and enhance link accessibility
…figure .dockerignore
…add branch support for dev
…nsuring proper JSON structure - added Streamlit dashboard
- Updated mkdocs.yml to include mkdocstrings plugin for better documentation generation. - Revised section headers in 1-ffmpeg.md, 2-cuda.md, and 3-docker.md for clarity. - Added new API documentation in whisper_tiktok.md. - Improved type hints and docstrings in command_executor.py and main.py for better code understanding. - Enhanced color_utils.py with detailed docstrings for the rgb_to_bgr function. - Included voice_manager import in __init__.py for better module accessibility.
- update pre-commit hook with black, isort and flake - added changelog config for future changelogs - update pyproject toml with build backend, dynamic version, extra requirements, pytest args
…d improving structure
…imports in __init__.py
…installation step
… pre-commit hooks
…ocumentation - Updated CONTRIBUTING.md to streamline contribution process and added new section for releasing a new version. - Removed Dockerfile and docker-compose.yml as part of the project restructuring. - Enhanced README.md and index.md for clarity and improved installation instructions. - Updated FFMPEG installation documentation across multiple files. - Added example Jupyter notebook for demonstrating usage. - Adjusted pyproject.toml for script naming and testing configurations. - Introduced new test_import.py to verify module import functionality. - Updated versioning in version.py to include a 'v' prefix.
…s in documentation
There was a problem hiding this comment.
Pull request overview
This PR prepares the v2.0.4 patch release by introducing dynamic semantic versioning/tagging, updating CI for docs/lint/type checks, generating a changelog, refreshing contribution/docs guidance, and removing Docker support.
Changes:
- Add dynamic versioning (
whisper_tiktok/version.py) and bump/tag/changelog tooling configuration. - Update packaging/CLI entrypoint (
whisper_tiktokscript), test configuration (xdist + nbmake), and CI workflows for MkDocs + pre-commit. - Refresh documentation/contributing guidance and remove Docker-related files/docs.
Reviewed changes
Copilot reviewed 24 out of 26 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| whisper_tiktok/version.py | Adds a single source of truth for the package version (2.0.4). |
| whisper_tiktok/utils/color_utils.py | Expands docstring documentation for rgb_to_bgr. |
| whisper_tiktok/main.py | Improves docstrings/type hints for the app orchestrator and helpers. |
| whisper_tiktok/execution/command_executor.py | Improves docstrings for executor behavior/parameters. |
| whisper_tiktok/init.py | Adds package marker file (currently comment-only). |
| tests/test_import.py | Adds a minimal import test for the package. |
| pyproject.toml | Moves to dynamic versioning, adds optional dependency groups, defines console script, updates pytest/tooling config. |
| mkdocs.yml | Enables mkdocstrings plugin configuration for API docs. |
| examples/notebook.ipynb | Adds a basic example notebook used by nbmake. |
| docs/index.md | Updates CLI docs + installation flow; adjusts headings/TOC. |
| docs/3-docker.md | Removes Docker documentation. |
| docs/2-cuda.md | Cleans up headings/anchors. |
| docs/1-ffmpeg.md | Cleans up headings/anchors. |
| docker-compose.yml | Removes docker-compose configuration. |
| SECURITY.md | Updates supported version range and reporting text. |
| README.md | Updates installation/CLI commands and contributing links. |
| Dockerfile | Removes Docker build. |
| CONTRIBUTING.md | Reworks contribution and release process documentation. |
| CHANGELOG.md | Adds generated changelog for v2.0.4. |
| .pre-commit-config.yaml | Simplifies hooks and adds flake8; updates tool revisions. |
| .github/workflows/release.yml | Removes Docker image release workflow. |
| .github/workflows/ci_mkdocs.yml | Updates MkDocs deploy workflow to use uv and mkdocstrings. |
| .github/workflows/ci-style-checks.yml | Switches style checks to pre-commit and refines triggers/matrix. |
| .changelog-config.yaml | Adds generate-changelog configuration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - [Introduction](#introduction) | ||
| - [Video (demo)](#demo-video) | ||
| - [Installation](#installation-️) |
There was a problem hiding this comment.
The Table of Contents link uses #installation-️ (includes an invisible variation selector). This anchor is unlikely to match MkDocs’ generated heading IDs and may break navigation. Prefer a stable anchor (e.g., #installation) or add an explicit <a id="installation"></a> target.
|
|
||
| - [Introduction](#introduction) | ||
| - [Video (demo)](#demo-video) | ||
| - [Installation](#installation-️) |
There was a problem hiding this comment.
The Table of Contents link uses #installation-️ (includes an invisible variation selector). This anchor is unlikely to match MkDocs’ generated heading IDs and may break navigation. Prefer a stable anchor (e.g., #installation) or add an explicit <a id="installation"></a> target.
| # Contributing | ||
|
|
||
| Thank you for your interest in contributing to our project! We appreciate your support and look forward to working with you. | ||
| All contributions to are welcome! |
There was a problem hiding this comment.
Grammar: "All contributions to are welcome!" should be "All contributions are welcome!"
| All contributions to are welcome! | |
| All contributions are welcome! |
|
|
||
| ### Improving Documentation | ||
| 6. Commit your changes and push your branch. | ||
| 7. Create a merge request describing your changes and linking any relevant issues. |
There was a problem hiding this comment.
This repository uses GitHub terminology elsewhere (issues/pull requests), but this step says "Create a merge request" (GitLab term). For consistency and clarity, change this to "Create a pull request".
| 7. Create a merge request describing your changes and linking any relevant issues. | |
| 7. Create a pull request describing your changes and linking any relevant issues. |
| [tool.setuptools.packages] | ||
| find = {} | ||
| [tool.setuptools] | ||
| py-modules = [ "whisper_tiktok" ] |
There was a problem hiding this comment.
[tool.setuptools] py-modules = ["whisper_tiktok"] is inconsistent with the project layout (there is a whisper_tiktok/ package directory, not a top-level whisper_tiktok.py module). This can break packaging/builds. Remove py-modules and rely on tool.setuptools.packages.find, or explicitly set packages = ["whisper_tiktok", ...] / adjust the find config.
| py-modules = [ "whisper_tiktok" ] |
| include_trailing_comma = true | ||
| multi_line_output = 3 | ||
|
|
||
| [tool.black] |
There was a problem hiding this comment.
[tool.black] is empty, so Black will use its default line length (88), while isort/flake8 are configured for 120. Add an explicit Black configuration (e.g., set line-length = 120) so the formatting tools agree.
| [tool.black] | |
| [tool.black] | |
| line-length = 120 |
Added
Changed
whisper_tiktokcommandRemoved