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

Add guide for tools #4982

Merged
merged 6 commits into from
Jul 15, 2024
Merged

Add guide for tools #4982

merged 6 commits into from
Jul 15, 2024

Conversation

zanieb
Copy link
Member

@zanieb zanieb commented Jul 10, 2024

No description provided.

@zanieb zanieb added documentation Improvements or additions to documentation preview Experimental behavior labels Jul 10, 2024
@zanieb
Copy link
Member Author

zanieb commented Jul 10, 2024

I need to figure out where I'm going to draw the line between these guides and the concept documentation pages.

@zanieb zanieb marked this pull request as ready for review July 11, 2024 14:51
Copy link
Member

@ibraheemdev ibraheemdev left a comment

Choose a reason for hiding this comment

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

Looks good, just some small nits.

docs/guides/tools.md Outdated Show resolved Hide resolved
docs/guides/tools.md Outdated Show resolved Hide resolved
$ uv tool install httpie
```

Additionally, package versions can be included without `--from`:
Copy link
Member

Choose a reason for hiding this comment

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

What's the benefit of this?

Copy link
Member Author

Choose a reason for hiding this comment

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

Of explaining it? --from isn't supposed to be used in uv tool install.

docs/guides/tools.md Outdated Show resolved Hide resolved
docs/guides/tools.md Outdated Show resolved Hide resolved
docs/guides/tools.md Outdated Show resolved Hide resolved
@T-256
Copy link
Contributor

T-256 commented Jul 12, 2024

Could you add some clarity about difference between uvx --from and uvx --with?

I think they are in common in all ways except of --from is one-time usable and it declares entry points of which package should be gathered.

I can suggest to merge --with and --from into one argument (e.g. --from). By keeping it multiple-times usable it in cli, by default, main package should be inferred from first/last passed --from argument. Which also could be overridden by separate argument e.g. --main.
Examples:

# inferred first `--from` as main package, so `fastapi` executable would be available.
$ uvx --from fastapi-cli --from fastapi fastapi dev

zanieb and others added 5 commits July 15, 2024 16:59
Co-authored-by: Ibraheem Ahmed <ibraheem@ibraheem.ca>
Co-authored-by: Ibraheem Ahmed <ibraheem@ibraheem.ca>
Co-authored-by: Ibraheem Ahmed <ibraheem@ibraheem.ca>
@zanieb zanieb enabled auto-merge (squash) July 15, 2024 22:03
@zanieb zanieb merged commit 35b268a into main Jul 15, 2024
41 checks passed
@zanieb zanieb deleted the zb/docs-tools branch July 15, 2024 22:04
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 preview Experimental behavior
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants