-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Expand entry points documentation #9329
Conversation
1e21945
to
42d58b4
Compare
I'm a little hesitant to spend times on the plugin entry-points and gui scripts but it is relevant? |
Personally, I'm fine with not discussing plugin entrypoints in uv, they may be explained by the app that wants to load that information. |
docs/concepts/projects/config.md
Outdated
These are only different from [command-line interfaces](#command-line-interfaces) on Windows, where | ||
they are wrapped by a GUI executable so they can be started without a console. On other platforms, | ||
they behave the same. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd put this front in this section, we can even roll the entire section into a paragraph at the end of the previous paragraph:
On windows,
[project.scripts]
will create a terminal. If you're writing a GUI application and don't want a terminal on Windows, use[project.gui-scripts]
instead.
I think it would be worthwhile to have a mention (even if it is brief) to application entry-points. Although the more detailed documentation can be found in the pyproject.toml specification & writing guide, I am sure a lot of new users will learn about the features of a pyproject.toml only from uv's documentation. If we can at least say those features are available and signpost where to find out more that would be very useful. I speak from what I would have found useful when I was learning. Hatch's pyproject.toml documentation is very good (possibly because it makes use of the plugin system in its build backend hatchling), whereas flake8 makes use of the plugin system and has quite outdated and lacking documentation in my opinion. Perhaps full examples are not necessary, but I think a mention to them would be very valuable |
The `group` key can be an arbitrary value, it does need to include the package name or | ||
"plugins". However, is recommended to namespace the key by the package name to avoid collisions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think some grammatical improvements can be made:
The `group` key can be an arbitrary value, it does not need to include the package name or
"plugins". However, it is recommended to namespace the key by the package name to avoid collisions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry I read this twice but can't spot the suggestion; what are you thinking?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The text in the commit has possible typos such as missing words. Perhaps it does need
should become it does **not** need
. Same with is recommended
to **it** is recommended
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah I see, thanks!
42d58b4
to
0709563
Compare
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.5.4` -> `0.5.5` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>astral-sh/uv (astral-sh/uv)</summary> ### [`v0.5.5`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#055) [Compare Source](astral-sh/uv@0.5.4...0.5.5) ##### Enhancements - Add aliases for build backend requests ([#​9294](astral-sh/uv#9294)) - Avoid displaying empty paths ([#​9312](astral-sh/uv#9312)) - Allow constraints in `uv tool upgrade` ([#​9375](astral-sh/uv#9375)) - Remove conflict between `--no-sync` and `--frozen` in `uv run` ([#​9400](astral-sh/uv#9400)) - Respect dependency sources in overrides and constraints ([#​9455](astral-sh/uv#9455)) - Show an interpreter-focused message for `--target` and `--prefix` ([#​9373](astral-sh/uv#9373)) - Add `--no-extra` flag and setting ([#​9387](astral-sh/uv#9387)) - Add `uv export --prune` ([#​9389](astral-sh/uv#9389)) - Add dedicated error message for musl install attempts ([#​9430](astral-sh/uv#9430)) - Add various grammar changes to conflict error messages ([#​9369](astral-sh/uv#9369)) - Annotate default groups in conflict error messages ([#​9368](astral-sh/uv#9368)) - Report marker diagnostics during parsing, rather than evaluation ([#​9338](astral-sh/uv#9338)) - Use consistent formatting for build system errors ([#​9340](astral-sh/uv#9340)) - Use rich diagnostics for build failures ([#​9335](astral-sh/uv#9335)) ##### Preview features - Improve build backend excludes ([#​9281](astral-sh/uv#9281)) - Include PEP 639 `license-files` metadata during `uv publish` ([#​9442](astral-sh/uv#9442)) ##### Performance - Initialize rayon lazily ([#​9435](astral-sh/uv#9435)) - Migrate to PubGrub's arena for package names ([#​9448](astral-sh/uv#9448)) ##### Bug fixes - Allow dependency groups to include the containing package ([#​9385](astral-sh/uv#9385)) - Allow syncing to empty virtual environment directories ([#​9427](astral-sh/uv#9427)) - Allow system Python discovery with `--target` and `--prefix` ([#​9371](astral-sh/uv#9371)) - Don't warn when `--output-file` is empty ([#​9417](astral-sh/uv#9417)) - Fix Python interpreter discovery on non-glibc hosts ([#​9005](astral-sh/uv#9005)) - Fix `tool.uv.dependency-metadata.[].version` schema ([#​9468](astral-sh/uv#9468)) - Only respect preferences across the same indexes ([#​9302](astral-sh/uv#9302)) - Re-compile when `--compile` is passed to an install operation ([#​9378](astral-sh/uv#9378)) - Remove `--upgrade`, `--no-upgrade`, and `--upgrade-package` from `uv tool upgrade` ([#​9318](astral-sh/uv#9318)) - Remove dev dependencies in `--all-groups --no-dev` ([#​9300](astral-sh/uv#9300)) - Surface extras and group conflicts in `uv export` ([#​9365](astral-sh/uv#9365)) - Treat deprecated aliases as equivalent in marker algebra ([#​9342](astral-sh/uv#9342)) - Treat less compatible tags as lower priority in resolver ([#​9339](astral-sh/uv#9339)) ##### Documentation - Avoid referencing `scikit-build` (instead of `scikit-build-core`) ([#​9320](astral-sh/uv#9320)) - Expand entry points documentation ([#​9329](astral-sh/uv#9329)) - Fix example `pyproject.toml` in project concept documentation ([#​9298](astral-sh/uv#9298)) - Fix header level of "Conflicting dependencies" page ([#​9330](astral-sh/uv#9330)) - Touch-up the extension module guide ([#​9293](astral-sh/uv#9293)) - Update the dependencies documentation ([#​9359](astral-sh/uv#9359)) - Reference `--no-progress` option in related environment variable ([#​9357](astral-sh/uv#9357)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40NDAuNyIsInVwZGF0ZWRJblZlciI6IjM3LjQ0MC43IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
No description provided.