nasa / fprime-tools

F´ Python tooling and helpers.
https://github.com/nasa/fprime
Apache License 2.0
20 stars 38 forks source link

New Deployment generation feature #123

Closed thomas-bc closed 1 year ago

thomas-bc commented 1 year ago
Originating Project/Creator
Affected Component
Affected Architectures(s) fprime-util new
Related Issue(s) https://github.com/nasa/fprime/issues/1926
Has Unit Tests (y/n)
Builds Without Errors (y/n) y
Unit Tests Pass (y/n)
Documentation Included (y/n) y

Change Description

Rationale

Addresses https://github.com/nasa/fprime/issues/1926. Will be used for short tutorials and workshops. Has been requested for a long time. The created deployment contains the basic CNDH stack so that users can get started easily.

Request for comments

The cookiecutter stuff is in fbuild/interaction.py which is a little odd hierarchy/naming. I was thinking of putting the new_*** functions in a new module under util/ but that would make yet more refactoring. Let me know if you think that's good or if you see issues with that and I'll put it in for the future new --project feature.

Future Work

TODO: loadParameter() has been commented out in the generated configureTopology() because the function is not autocoded yet. A fix will likely be made where the function gets autocoded even if not parameters are used. Should be un-commented then.

We could add the following cookiecutter options:

LeStarch commented 1 year ago

Some minor change requests, otherwise this refactor looks really nice!

LeStarch commented 1 year ago

Two other comments:

  1. Spelling failed, those new templates bring a lot of spelling that we fixed in F´ core
  2. Installation, make sure to run pip install without -e to make sure the templates installed correctly.
thomas-bc commented 1 year ago
  1. spelling fixed
  2. I was able to install locally without -e with no issue

I addressed your comments, ready for re-review