summaryrefslogtreecommitdiff
path: root/docs/userguide/entry_point.rst
Commit message (Collapse)AuthorAgeFilesLines
* Clarify language re: function argumentsMoshe Kaplan2023-03-151-2/+2
| | | Configured indicates that the function code's itself would be configured, not that it is used by an external party. Switch verb to "used" to be clearer as to how the function is being used.
* Get rid of trailing spaces, mainly in docsDimitri Papadopoulos2022-11-201-1/+1
|
* Update development mode docsAnderson Bravalheri2022-06-251-0/+2
|
* docs: Reorder example tabsAnderson Bravalheri2022-06-161-34/+34
|
* Change wording from *experimental* to *beta*Anderson Bravalheri2022-06-161-9/+4
|
* Fix up subsections of the "Entry Points for Plugins" sectionSaniya Maheshwari2022-06-121-15/+10
| | | | | - Convert the `importlib.metadata` subsection into a Tip. - Remove the 'Summary' subsection header.
* Apply suggestions from code reviewSaniya Maheshwari2022-06-121-3/+4
| | | Co-authored-by: Anderson Bravalheri <andersonbravalheri+github@gmail.com>
* Added a single space around the `=` sign in `setup.py` snippetsSaniya Maheshwari2022-06-121-5/+5
| | | | | | Have checked that the snippets continue to work with this space included. The space improves readability, hence this is probably a good addition.
* Fixed up indentation issueSaniya Maheshwari2022-06-121-5/+5
| | | | | Some extra indentation was causing the code block to be interpreted as a code block within a blockquote.
* Added a few lines to make the purpose of the syntax clearSaniya Maheshwari2022-06-121-1/+21
| | | | | | A few lines have been added in each of the sections on Console Scripts, GUI scripts and Entry Points for Plugins. A line has also been added at the end of the Syntax section to further make things clear.
* Section on Entry Points SyntaxSaniya Maheshwari2022-06-121-10/+55
| | | | | | | | | | | | Matter is courtesy of @abravalheri. Have removed the `.ini` syntax highlighting of the code blocks so that the syntax does not appear specific to `setup.cfg` but more general-purpose. Have also moved this section down to the end of the document so that users can refer to it after having a basic understanding of how each of console scripts, GUI scripts, and entry points work.
* Removed Dependency Management section of the Entry Points pageSaniya Maheshwari2022-06-111-23/+0
| | | | | Since it is deprecated and relevant details have already been covered in a separate Dependencies Management page.
* Added note in `pyproject.toml` snippet for plugin exampleSaniya Maheshwari2022-06-111-0/+1
| | | | | Explains why quoting around `timmins.display` is required. Might be helpful for beginners.
* Changed indentation in `setup.cfg` snippetsSaniya Maheshwari2022-06-111-9/+9
| | | | | | Indentation was 8 spaces. Should be 4 spaces for consistency with other `setup.cfg` snippets. Also fixed up tab/spaces glitches in other places.
* Better opening statement for the Entry Points pageSaniya Maheshwari2022-06-111-4/+15
|
* Plugin name is `timmins-plugin-fancy`Saniya Maheshwari2022-06-111-3/+3
| | | | | Had incorrectly used `timmins_plugin_fancy` instead of `timmins-plugin-fancy` in several places.
* Corrected syntax in `setup.py`Saniya Maheshwari2022-06-111-2/+2
| | | | | Had used `=` for separating key and value pair in dictionary, should have `:` instead.
* Apply suggestions from code reviewAnderson Bravalheri2022-06-111-2/+2
|
* Changed the last paragraph of the old example into a summary statementSaniya Maheshwari2022-06-111-3/+8
|
* Removed example in old documentationSaniya Maheshwari2022-06-111-30/+0
| | | | | | | - Old example was on loading entry points corresponding to console scripts. - Everything in that example has probably been included in the newer example.
* Illustrate different ways of implementing/loading EPsSaniya Maheshwari2022-06-111-0/+73
| | | | | | - Defining multiple EPs under the same group - Loading an EP by its name - Loading all EPs in a given group
* This statement is not requiredSaniya Maheshwari2022-06-111-2/+0
|
* Replace 'console script' with 'console/GUI script'Saniya Maheshwari2022-06-111-2/+2
| | | | In the Advertising Behaviour section.
* Subsection on `importlib.metadata` and its backportSaniya Maheshwari2022-06-111-3/+16
| | | | | | | | - 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`.
* Added a note on what `display_eps` would look likeSaniya Maheshwari2022-06-101-4/+15
| | | | Snippet borrowed from Python Packaging user guide
* Added a lengthy example on entry points and pluginsSaniya Maheshwari2022-06-101-3/+165
|
* Added blank lineSaniya Maheshwari2022-06-101-0/+1
| | | | Fixes warning emitted during `tox -e docs`
* Fix verbatim in rst docsAnderson Bravalheri2022-06-091-1/+1
|
* Add note regarding `PySimpleGUI` Saniya Maheshwari2022-06-091-0/+3
| | | | | `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>
* Apply suggestions from code reviewSaniya Maheshwari2022-06-091-5/+4
| | | Co-authored-by: Anderson Bravalheri <andersonbravalheri+github@gmail.com>
* Modified Console scripts exampleSaniya Maheshwari2022-06-091-5/+9
| | | | | | 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.
* Function configured as console/GUI script should not take argumentsSaniya Maheshwari2022-06-091-0/+10
| | | | | | 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.
* Elaborated on the 'wrapper script' partSaniya Maheshwari2022-06-091-5/+17
| | | | | | | | | | 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 note on distinction between `console_scripts` and `gui_scripts`Saniya Maheshwari2022-06-091-0/+13
| | | | | | 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`.
* Added 'GUI Scripts' sectionSaniya Maheshwari2022-06-091-0/+52
| | | | | | | | | | - 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.
* Illustrate input/output with/without console scriptsSaniya Maheshwari2022-06-081-2/+8
| | | | | | - 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.
* Changed `setup.py` snippet in console scripts exampleSaniya Maheshwari2022-06-081-8/+5
| | | | | | | - 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 `pyproject.toml` snippet for console scripts exampleSaniya Maheshwari2022-06-081-1/+15
|
* Changed the example illustrating usage without console scriptsSaniya Maheshwari2022-06-081-9/+9
| | | | | | | | | | | - 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.
* Fix warnings for pypi references.Jason R. Coombs2022-03-191-1/+1
|
* Update entry_point.rstXing Han Lu2022-03-021-4/+25
|
* Correct typo (s/brakets/brackets/)Rupert Nash2021-09-091-1/+1
|
* Restore whitespace and single quotes after blacken-docs.Jason R. Coombs2021-07-211-3/+3
|
* blacken docsThomas Grainger2021-07-201-5/+7
|
* Add ini to display code block in docThea2021-02-241-1/+1
|
* fix typoYuanPei Li2021-01-081-1/+1
| | | Fix a difference between the name of function definition and calling.
* Merge branch 'master' into patch-2谭九鼎2020-10-171-1/+3
|\
| * 📝 Recover interdoc links & correct broken syntaxSviatoslav Sydorenko2020-10-161-3/+7
| |
* | Update entry_point.rst谭九鼎2020-10-031-0/+2
| |
* | docs: code-block style fix谭九鼎2020-10-021-6/+6
|/
View Lorry Controller Status