Wakoma / nimble

The nimble. An open source, rapidly deployable, wireless mesh network.
CERN Open Hardware Licence Version 2 - Strongly Reciprocal
56 stars 9 forks source link

Refactor code to allow configuration #53

Closed julianstirling closed 1 month ago

julianstirling commented 1 month ago

The first commit is really large as I was just trying to make a first pass through.

This PR will:

Things that need to be done after this is merged:

julianstirling commented 1 month ago

Hi @jmwright, A bit of a chunky PR this one! It should be ready for review, and merging if you don't have any issues.

It is a little bit of a backwards step in that we no longer get the identified build zip. But there has been a lot of work to modularise and to make it so that generate and generate_static use the back end orchestration code. I think it best to merge before doing any more major changes and then I can work on getting builds for a specific configuration.

EDITED to say For some reason the if didn't work and this branch tried to deploy, but the protection rule stopped it. So the result is still good even if we get a "Some checks were not successful"

jmwright commented 1 month ago

@julianstirling Is there documentation on how to run this new code properly? I can create an environment, do pip install -e ., and then run both ./generate.py and ./generate_static.py. I'm not sure if I should be interacting with the orchestration script directly though.

julianstirling commented 1 month ago

Great question Jeremy. As of now the only way I have run it is running generate.py and generate_static.py this PR is more about getting it in the state where I feel that it is flexible enough that we could do other custom things. I don't actually have any examples or process for doing that yet.

Perhaps I'll update the README to explain this current state so it is clear? More complex interaction are still a bit of dev away.

jmwright commented 1 month ago

The README was the first place I looked after I checked out the code, so a little more information there probably wouldn't hurt.

Otherwise, I think this is ready to merge so that the next phase can start.

julianstirling commented 1 month ago

Thanks. Are you happy that if I fix the comment above and add something to the README, then I'll merge?

jmwright commented 1 month ago

Yes, +1 to merge.

julianstirling commented 1 month ago

Thanks. I have made minor tweaks to the README which point those wishing to run locally towards generate.md. This is then updated to explain how to install and run the project now.