Changes to the User Guide's Entry Points page #3355
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Using `src` layout for consistency with other examples in the documentation. - Using a tree diagram. - Showing a `setup.py` file in the diagram with a comment indicating that `setup.cfg` or `pyproject.toml` can also be used, again for consistency with other examples in the documentation. - Root directory is kept as `project_root_directory` to indicate that any name can be used.
- I think there is no need to include name, version, `packages`, etc. They haven't been included in the equivalent `setup.cfg` snippet as well as in other snippets in the documentation. - Fixed up indentation by changing tabs to 4 spaces.
- Added output of the command `python -m timmins`. - Added input and output when a console script is set up, i.e. when `hello-world` is run on the terminal.
- Made separate section for `gui_scripts` - Added an example `hello_world()` function that can be invoked using a GUI script entry point - Added `setup.cfg`, `setup.py` and `pyproject.toml` configuration snippets - Added that running `hello-world` in the terminal will open up a GUI window.
This note has been taken from the Python Packaging user guide. I think it will be of interest to users who want to understand what is the difference between `console_scripts` and `gui_scripts`.
Removed a line stating that installers like Pip create wrapper scripts around the function, and replaced it with a longer note at the end of the GUI scripts section. This note includes a sample wrapper script taken from the Python Packaging user guide. I think this longer note along with an actual example of how the wrapper script might look like will make it more clear to the user how console/GUI scripts work behind the scenes.
Added two lines to make this clear to users. Also added that any parsing of user input can take place within the body of the function using regular command-line parsing utilities.
Changed the wording of the console scripts example, so that it is more clear why `__main__.py` is required and why console scripts are a better alternative.
abravalheri
approved these changes
Jun 9, 2022
abravalheri
reviewed
Jun 9, 2022
Co-authored-by: Anderson Bravalheri <andersonbravalheri+github@gmail.com>
`PySimpleGUI` must be added to package dependencies in order to run the example in the GUI scripts section. Co-authored-by: Anderson Bravalheri <andersonbravalheri+github@gmail.com>
abravalheri
reviewed
Jun 9, 2022
|
@codeandfire, please let me know when you are happy and we can merge this change :) |
|
Sure @abravalheri, I just have some changes in mind for the second part of the page involving the plugin-related entry points, and I think I will finish them in a day. After that can we merge this commit? |
|
Yeah, of course, no rush. |
Fixes warning emitted during `tox -e docs`
Snippet borrowed from Python Packaging user guide
- Indicated that for Python versions lower than 3.8, the backport should be used. - Indicated that the only change that needs to be made while using the backport, is to replace `importlib.metadata` with `importlib_metadata`.
In the Advertising Behaviour section.
- Defining multiple EPs under the same group - Loading an EP by its name - Loading all EPs in a given group
- Old example was on loading entry points corresponding to console scripts. - Everything in that example has probably been included in the newer example.
|
Hi @abravalheri, a bit late but I've finished my work on the Entry Points page. I have written a lot of new material, please let me know your feedback! |
abravalheri
approved these changes
Jun 11, 2022
There was a problem hiding this comment.
Thank you very much @codeandfire.
The changes in the documentation are superb, I am very glad to have you as a contributor.
|
Thank you @abravalheri for your kind words. It's a pleasure to contribute to Setuptools, especially when you as a maintainer are so helpful and responsive! |
codeandfire
added a commit
to codeandfire/setuptools
that referenced
this pull request
Jun 11, 2022
I forgot to add this.
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes
Console scripts section:
pyproject.tomlsnippetsetup.pysnippet (corrected indentation and removed unnecessary name, version, etc. fields)Added GUI Scripts section:
setup.cfg/setup.py/pyproject.tomlsnippetsOther changes:
Have not finished this yet. Will update here with further changes.
Pull Request Checklist
changelog.d/.(See documentation for details)