Skip to content

Make a Functional MADSci Module #3

@RyanTheRobothead

Description

@RyanTheRobothead

Issues with the current implementation that need addressing:

  • Doesn't build and run in docker
  • Contains extraneous files
  • Does not conform to MADSci code quality standards and module conventions
  • Hasn't been rigorously tested on the robot

Some things that can be done to address the above:

  • Update the pyproject.toml to include madsci.node_module, madsci.common, and madsci.client dependencies, and remove the ad_sdl.wei package
  • Update the Dockerfile to extend the MADSci docker image, rather than the WEI docker image
  • Update the compose.yaml to serve as a proper build and test harness for a MiR node service (existing maintainted MADSci modules can be used as a guide)
  • Remove the wei.compose.yaml
  • Remove the vestigial tests/ directory
  • Update pre-commit hooks, using an existing maintained MADSci module as a guide, and ensure that the checks pass with pre-commit run --all-files
  • Remove the old Makefile, and, if feeling ambitious, replace with a .justfile
  • Rename mir_driver to mir_interface to match MADSci naming conventions
  • Remove "Development Tools" section of pyproject.toml and port ruff.toml from an existing maintained MADSci module
  • Adjust locations to be a dictionary rather than a file
  • Ensure the Dockerfile builds
  • Test that node works using MiR's in RPL
  • Update README.md to ensure it provides useful and up-to-date documentation about the purpose and usage of the software.

Metadata

Metadata

Assignees

Labels

choreMaintenance, tooling improvements, etc.documentationImprovements or additions to documentationenhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions