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

Explicitly document using uv to run and manage the project #120

Closed
harshil21 opened this issue Jan 2, 2025 · 1 comment
Closed

Explicitly document using uv to run and manage the project #120

harshil21 opened this issue Jan 2, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@harshil21
Copy link
Member

harshil21 commented Jan 2, 2025

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 using uv 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.

@harshil21 harshil21 added the documentation Improvements or additions to documentation label Jan 2, 2025
@wlsanderson
Copy link
Contributor

Closed with #121

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

No branches or pull requests

2 participants