Restructure and clean node configuration pipeline

Open
#77 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
backend

Research direction

Start by reading ark/client/comm_infrastructure/endpoint.py lines 37-121 to understand the current node configuration pipeline and its supported options. Clarify whether the intended result is path-based configuration, one configuration or CLI per node, global communication parameters, or serviceable parameters; done requires a decided design and corresponding simplified pipeline.

Written by the indexing model from the issue text.

Description

invalid

Current node configuration pipeline is convoluted, and a better solution is required.

https://github.com/Robotics-Ark/ark_framework/blob/fd76793ad90be4ed766c81faf738cc0f735280a4/ark/client/comm_infrastructure/endpoint.py#L37-L121

  • Too much freedom is given to the user (ie better to just get them always to simply pass a path).
  • We can simplify to one configuration (or even simply a CLI) per node.
  • Having a global configuration potentially still could be possible, eg for communication handling - ie parameters that apply to everything.
  • Potential idea: make parameters automatically be serviceable (ie other nodes can retrieve parameter values)
Dominant language
Python
Stars
623
Forks
156
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Robotics-Ark/ark_framework

All issues in Robotics-Ark/ark_framework

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.