Skip to content

Conversation

@langestefan
Copy link

@langestefan langestefan commented Aug 3, 2025

This modernizes the project to use pyproject.toml with default layout with dedicated src and tests folders.

I have also added several code quality checks using ty and ruff. These can be made available to the developer using pre-commit and are also added as checks in CI.

Note that much of the docs content is still missing, at this stage it is a skeleton.

The following tasks still need to be completed:

  • ruff and ty checks do not pass
  • links in documentation need to be changed to point to the correct addresses
  • unit tests for JAX are not formatted yet
  • most of the source code is missing awaiting the rewrite from Parth
  • type checking and linting can be quite finicky. We will have to use ruff.toml files to exclude the checks we don't want to do (see https://docs.astral.sh/ruff/configuration/). I have already created two ruff.toml files, one for tests and one for examples.
  • We will need to update the build script. We don't have to use uv for that, but it's probably the best option out there at the moment. The way I have setup pyproject.toml should make the main package lean.
  • Automatically creating API documentation from docstrings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant