Skip to content

chore: restructure dependencies with PEP 735 groups, bump pins, switch docs to properdocs - #91

Open
neomatamune wants to merge 1 commit into
mainfrom
chore/dependency-groups-and-bumps
Open

neomatamune wants to merge 1 commit into
mainfrom
chore/dependency-groups-and-bumps

Conversation

@neomatamune

Copy link
Copy Markdown
Member

Summary

  • Move dev/doc/test tooling from optional-dependencies to PEP 735 [dependency-groups] (dev, doc, test, all), matching the layout used in ASSET_TENANT/API. Only the real runtime extra (custom) stays as a published optional-dependency.
  • Inline all dependencies directly in pyproject.toml (no more requirements*.txt indirection) so SBOM tooling reads them straight from package metadata. Delete the now-unused requirements*.txt files.
  • Make the package version static (version = "2.4.2" in [project]) instead of dynamic from cosmotech.coal.__version__; __init__.py now derives __version__ from pyproject.toml (falling back to installed package metadata), mirroring ASSET_TENANT/API.
  • Bump dependency pins to the latest minor/patch achievable within their current major (verified against actually installable/resolvable versions), including a major bump of pandas to ~=3.1 after confirming the full test suite passes cleanly with no deprecation warnings.
  • Replace mkdocs with properdocs in the doc group; rename mkdocs.yml to properdocs.yml; add NO_MKDOCS_2_WARNING to the gh-pages workflows.
  • Update CI workflows, CONTRIBUTING.md, README.md, BLACK_SETUP.md and the tutorial setup script to install via pip install -e . --group <name> instead of extras/requirements files.
  • Update docs/scripts/generate_dependencies_markdown.py to read dependencies straight from pyproject.toml instead of requirements*.txt.

Test Plan

  • Fresh-venv installs of every dependency-group combination (custom, dev, doc, test, all)
  • Full pytest suite: 409 passed
  • black --check .
  • sdist/wheel build + METADATA inspection
  • properdocs build and mike list
  • pip-audit before/after: 178 vulnerabilities / 19 packages -> 8 vulnerabilities / 2 packages (remaining two require major bumps of black and pymdown-extensions, intentionally left out of scope)

…h docs to properdocs

- Move dev/doc/test tooling from optional-dependencies to PEP 735
  [dependency-groups] (dev, doc, test, all), matching the layout used in
  ASSET_TENANT/API. Only the real runtime extra (custom) stays as a
  published optional-dependency.
- Inline all dependencies directly in pyproject.toml (no more
  requirements*.txt indirection) so SBOM tooling reads them straight from
  package metadata. Delete the now-unused requirements*.txt files.
- Make the package version static (version = "2.4.2" in [project])
  instead of dynamic from cosmotech.coal.__version__; __init__.py now
  derives __version__ from pyproject.toml (falling back to installed
  package metadata), mirroring ASSET_TENANT/API.
- Bump dependency pins to the latest minor/patch achievable within their
  current major (verified against actually installable/resolvable
  versions), including a major bump of pandas to ~=3.1 after confirming
  the full test suite passes cleanly with no deprecation warnings.
- Replace mkdocs with properdocs in the doc group; rename mkdocs.yml to
  properdocs.yml; add NO_MKDOCS_2_WARNING to the gh-pages workflows.
- Update CI workflows, CONTRIBUTING.md, README.md, BLACK_SETUP.md and the
  tutorial setup script to install via 'pip install -e . --group <name>'
  instead of extras/requirements files.
- Update docs/scripts/generate_dependencies_markdown.py to read
  dependencies straight from pyproject.toml instead of requirements*.txt.

Verified: fresh-venv installs of every dependency-group combination, full
pytest suite (409 passed), black --check, sdist/wheel build with METADATA
inspection, properdocs build, mike list, and pip-audit before/after
(178 vulnerabilities/19 packages -> 8 vulnerabilities/2 packages, the
remaining two requiring major version bumps of black and
pymdown-extensions that were intentionally left out of scope).
@neomatamune
neomatamune requested review from lalepee and a balanced review from Copilot November 17, 2026 15:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The package lacks a Python minimum, Pages workflows and setup instructions may use pip without --group support, and version detection can read unrelated project metadata or break imports.

3 open issues
What changed in this PR

Modernizes dependency management for the acceleration library by centralizing package metadata in pyproject.toml, adopting PEP 735 development groups, and switching documentation tooling to ProperDocs.

Changes:

  • Inline dependencies, update version pins—including pandas 3.1—and replace tooling extras with dependency groups while preserving the runtime custom extra.
  • Make version 2.4.2 static in project metadata and derive __version__ from source or installed metadata.
  • Update documentation generation, CI workflows, and contributor instructions for the new dependency layout.
File Description
tutorial/​contributing/​setup/​install_deps.bash Install the development dependency group.
requirements.txt Remove runtime requirements moved into project metadata.
requirements.test.txt Remove requirements moved into the test group.
requirements.doc.txt Remove requirements moved into the documentation group.
requirements.dev.txt Remove requirements moved into the development group.
requirements.custom.txt Remove requirements moved into the runtime extra.
requirements.all.txt Remove the extras-based aggregate requirements file.
README.md Update test dependency installation instructions.
pyproject.toml Centralize dependencies, define groups, update pins, and set a static version.
properdocs.yml Provide the documentation configuration under the ProperDocs filename.
docs/​scripts/​generate_dependencies_markdown.py Generate dependency documentation from project metadata.
cosmotech/​coal/​__init__.py Resolve the version from source or installed metadata.
CONTRIBUTING.md Update development environment setup.
BLACK_SETUP.md Update formatter dependency installation.
.github/​workflows/​track_dependencies.yml Install the project for dependency tracking and SBOM generation.
.github/​workflows/​test.yml Install test dependencies through the test group.
.github/​workflows/​tag_latest_release_gh_page.yml Use the documentation group and suppress the MkDocs warning.
.github/​workflows/​retro_copat_test.yml Use the test group for compatibility checks.
.github/​workflows/​lint.yml Install development tooling through the dev group.
.github/​workflows/​generate_gh_page.yml Use the documentation group and suppress the MkDocs warning.
.github/​workflows/​check_untested_functions.yml Install the test group for coverage checks.

Review effort: Balanced

with:
python-version: 3.11
- run: pip install -e .[doc]
- run: pip install -e . --group doc
Comment on lines +19 to +20
with open(pyproject_path, "rb") as f:
return tomllib.load(f)["project"]["version"]
Comment thread pyproject.toml
name = "cosmotech_acceleration_library"
authors = [{ name = "Cosmo Tech", email = "platform@cosmotech.com" }]
description = "Acceleration libraries for CosmoTech cloud based solution development"
version = "2.4.2"

This branch has not been deployed

No deployments
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.

2 participants