Skip to content

Whisper-TikTok Release v2.0.4 @ patch#50

Merged
MatteoFasulo merged 178 commits into
mainfrom
prepare-release
Jan 25, 2026
Merged

Whisper-TikTok Release v2.0.4 @ patch#50
MatteoFasulo merged 178 commits into
mainfrom
prepare-release

Conversation

@MatteoFasulo
Copy link
Copy Markdown
Owner

Added

  • semantic versioning with bump my version to bump and tag new releases
  • CI/CD for docs, linting and type checking
  • automatic changelog
  • new docs on contributing

Changed

  • build backend providing simpler command-line interface via whisper_tiktok command
  • dependencies splitted into groups (dev and docs)
  • only isort and black as additional tools
  • pre-commit hook configuration
  • pytest configuration using multiple workers and testing also notebooks

Removed

  • docker support (will be available again once the project structure will be definitive)
  • old CI/CD not applicable anymore

MatteoFasulo and others added 25 commits December 12, 2025 17:32
…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
…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.
Copilot AI review requested due to automatic review settings January 25, 2026 16:46
@MatteoFasulo MatteoFasulo merged commit 6dcb0f9 into main Jan 25, 2026
5 checks passed
@MatteoFasulo MatteoFasulo deleted the prepare-release branch January 25, 2026 16:50
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_tiktok script), 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.

Comment thread README.md

- [Introduction](#introduction)
- [Video (demo)](#demo-video)
- [Installation](#installation-️)
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment thread docs/index.md

- [Introduction](#introduction)
- [Video (demo)](#demo-video)
- [Installation](#installation-️)
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment thread CONTRIBUTING.md
# 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!
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar: "All contributions to are welcome!" should be "All contributions are welcome!"

Suggested change
All contributions to are welcome!
All contributions are welcome!

Copilot uses AI. Check for mistakes.
Comment thread CONTRIBUTING.md

### Improving Documentation
6. Commit your changes and push your branch.
7. Create a merge request describing your changes and linking any relevant issues.
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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".

Suggested change
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.

Copilot uses AI. Check for mistakes.
Comment thread pyproject.toml
[tool.setuptools.packages]
find = {}
[tool.setuptools]
py-modules = [ "whisper_tiktok" ]
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Suggested change
py-modules = [ "whisper_tiktok" ]

Copilot uses AI. Check for mistakes.
Comment thread pyproject.toml
include_trailing_comma = true
multi_line_output = 3

[tool.black]
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Suggested change
[tool.black]
[tool.black]
line-length = 120

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants