Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Telecommand Spreadsheet Generator #23

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

meagan-davies
Copy link
Contributor

A spreadsheet generator for telecommands to help with readability of existing telecommands in the Firmware.

Copy link
Contributor

@DeflateAwning DeflateAwning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks so great!

Overall, don't copy-and-paste functions from other files. Instead, use imports to include the functions from other places in the repo. For example:

from cts1_ground_support.telecommand_array_parser import parse_telecommand_list_from_repo
from cts1_ground_support.telecommand_types import TelecommandDefinition

Please avoid using "noqa" comments. The reason the linter is enabled is to give feedback on best practices in Python.

Let's store the output in a folder in the root of the repository called "exports". Add that folder to the .gitignore file so that the files created in it aren't stored in the repo. Also, delete the spreadsheets/ folder.

If you haven't yet - in the virtual environment, run pip install .[dev] to install development dependencies so that you get feedback right in your editor. That way, you don't have to push your changes to GitHub to see if they're valid. It'll also offer some "automatically fix" suggestions.

I'm really happy this exists now :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants