Explicitly document using uv
to run and manage the project
#120
Labels
documentation
Improvements or additions to documentation
uv
to run and manage the project
#120
Over the past few days, I've been reading through
uv
's docs a lot more to understand more of its features. Now that I've read and understood almost everything it has to offer, it is has become increasingly clear that usinguv
to manage the project and run the application is the best way for both us and new developers to get things running. Let me illustrate-Using
uvx
, we can do a literal one command execution to run the mock sim:uvx --from git+https://github.com/NCSU-High-Powered-Rocketry-Club/AirbrakesV2.git mock
You don't need
git
.You don't need to setup/activate a
venv
.You don't need to manually install dependencies.
You don't even need PYTHON!
The only thing required to enable this is moving a few files around, and defining an entry point for our application in the
pyproject.toml
.The README will also be updated to showcase this, and how to use the local dev environment. For those who refuse to use this amazing tool, alternate instructions to run and setup the project will be provided.
The text was updated successfully, but these errors were encountered: