Conversation
Contributor
Reviewer's GuideModernizes project metadata and tooling by defining pyproject.toml project metadata with setuptools_scm, moving dev dependencies (including audbcards>=0.4.3) into a uv-friendly dependency group, standardizing on Python 3.12, and updating CI/docs workflows and pre-commit hooks to use newer GitHub Actions, uv for running docs builds, and newer linting tools. Sequence diagram for updated docs build using uv in CIsequenceDiagram
participant GitHubActions as GitHubActions
participant Runner as Runner
participant uv as uv
participant Python as Python
participant Sphinx as Sphinx
GitHubActions->>Runner: Trigger doc workflow (push or PR)
Runner->>Runner: actions/checkout_v4
Runner->>Runner: actions/setup_python_v5 (python 3_12)
Runner->>Runner: actions/cache_v4 (.cache/audbcards)
Runner->>Runner: apt install libs (libsndfile1 ffmpeg mediainfo)
Runner->>uv: uv run python pre-fill-cache_py
uv->>Python: Execute pre-fill-cache script
Python-->>uv: Cache warmed with audbcards
uv-->>Runner: pre-fill-cache completed
Runner->>uv: uv run python -m sphinx docs docs_build -b html
uv->>Python: Start Sphinx module
Python->>Sphinx: Build HTML documentation
Sphinx-->>Python: Build success or failure
Python-->>uv: Exit code
uv-->>Runner: Propagate exit code
Runner-->>GitHubActions: Report workflow status
Flow diagram for project metadata and tooling modernizationflowchart TD
A[Start] --> B[Define project metadata in pyproject_toml
name authors license urls dynamic version]
B --> C[Configure setuptools_scm in pyproject_toml]
C --> D[Create dependency-groups section
with dev deps including audbcards >= 0_4_3]
D --> E[Adopt Python 3_12
update CI workflows
and pre-commit default_language_version]
E --> F[Update GitHub Actions
checkout v4
setup_python v5
cache v4
gh_pages v4]
F --> G[Switch docs build in CI
to uv run pre-fill-cache_py and sphinx]
G --> H[Remove docs/requirements_txt
pip install no longer used]
H --> I[Update pre-commit hook versions
ruff and codespell]
I --> J[End]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
This file contains hidden or 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
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.
Use
uvto handle CI and development, and depend on the latest version ofaudbcardsto avoid example media file issue for datasets that contain audio and json files.Summary by Sourcery
Adopt uv-based workflows for documentation and publishing while modernizing project metadata and CI configuration.
New Features:
Enhancements:
Build:
CI:
Deployment: