Make a Functional MADSci Module
Open
@tginsbu1 is already working on this.
Since Apr 2, 2026.
chore
documentation
enhancement
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
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.tomlto includemadsci.node_module,madsci.common, andmadsci.clientdependencies, and remove thead_sdl.weipackage - Update the
Dockerfileto extend the MADSci docker image, rather than the WEI docker image - Update the
compose.yamlto 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_drivertomir_interfaceto match MADSci naming conventions - Remove "Development Tools" section of
pyproject.tomland portruff.tomlfrom 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.mdto ensure it provides useful and up-to-date documentation about the purpose and usage of the software.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.