Skip to content

development.md

Latest commit

 

History

History
43 lines (29 loc) · 1.24 KB

development.md

File metadata and controls

43 lines (29 loc) · 1.24 KB
Raw

Development

Setup

pip install -e ".[dev]"

Quality checks

python scripts/verify.py
python scripts/verify.py --fix   # apply whitespace/import fixes first

verify.py runs autopep8, isort, black, mypy, pylint, bandit, pip-audit, and pytest.

Tests

pytest
pytest -m unit
pytest -n auto    # parallel (requires pytest-xdist)

Minimum coverage threshold is 90%, configured in .coveragerc.

Releasing

  1. Update version in pyproject.toml
  2. Run python scripts/verify.py
  3. Commit and push to main

When the version in pyproject.toml changes on main, CI automatically builds wheels, the Windows executable, creates a GitHub Release tagged v<version>, and publishes to PyPI. Pull requests and pushes that do not change the version run quality checks only.

The Windows executable is built with PyInstaller using SubtitleTools.spec and scripts/pyi_build.py. CI installs the CPU-only PyTorch wheel before packaging to avoid CUDA-related bundling noise.

Project layout

  • src/subtitletools/ — package source
  • tests/ — pytest suite
  • scripts/ — verify and PyInstaller helpers
  • SubtitleTools.spec — PyInstaller specification