summaryrefslogtreecommitdiff
path: root/docs/userguide
Commit message (Collapse)AuthorAgeFilesLines
...
* | | 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.
* | Changes to the User Guide's Entry Points page (#3355)Anderson Bravalheri2022-06-111-56/+399
|\ \
| * | 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.
* | | Apply suggestions from code reviewAnderson Bravalheri2022-06-111-1/+1
| | | | | | | | | Co-authored-by: cdfarrow <cdfarrow@users.noreply.github.com>
* | | Apply suggestions from code reviewAnderson Bravalheri2022-06-101-1/+1
| | |
* | | Add clarifications to setup.cfg guidesAnderson Bravalheri2022-06-101-9/+28
| | |
* | | Clarify glob pattern matching for dotfiles in User's Guide (#3350)Marco Weber2022-06-091-0/+5
|/ /
* | Replaced single backticks with double backticksSaniya Maheshwari2022-06-081-2/+2
| | | | | | | | | | | | For the `exclude_package_data` example added recently, there were single backticks around `.gitignore`, `.gitattributes` etc. which leads to the docs failing to build locally.
* | Changes to the User Guide's Data Files page (#3335)Anderson Bravalheri2022-06-071-105/+450
|\ \
| * | Small changes avoiding mentioning distutils directlyAnderson Bravalheri2022-06-071-4/+8
| | |
| * | Add a more realistic example for exclude-package-dataAnderson Bravalheri2022-06-071-8/+13
| | |
| * | Apply suggestions from code reviewAnderson Bravalheri2022-06-071-4/+4
| | |
| * | Added an `include_package_data` snippet to the subdirectory exampleSaniya Maheshwari2022-05-311-2/+46
| | | | | | | | | | | | | | | Just to make it clear that we can use either one of `package_data` or `include_package_data` and not just the former.
| * | Added sectionsSaniya Maheshwari2022-05-311-82/+98
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Added `include_package_data`, `package_data` and `exclude_package_data` sections to make clear the three options provided by Setuptools to manage data files. - Added a separate section illustrating the use of a `data` subdirectory, after these three sections. - Placed the summary of the three options under a Summary section. - Changed the levels of the last two sections to match the level of the five sections added. - Small changes. Changed the wording where appropriate to suit the new flow. Changed a paragraph on path separators in glob patterns to a Note.
| * | Removed footnoteSaniya Maheshwari2022-05-311-5/+5
| | | | | | | | | | | | | | | | | | | | | This footnote describes what Setuptools considers as a data file. This note is important and may be missed by the reader if it is kept as a footnote, hence I have copied its contents up ahead in the document, just after the `include_package_data` example.
| * | Added `packages`, `package_dir` and `where` options in all examplesSaniya Maheshwari2022-05-311-3/+29
| | | | | | | | | | | | For consistency.
| * | Removed footnoteSaniya Maheshwari2022-05-311-6/+1
| | | | | | | | | | | | | | | I believe this footnote is outdated and not required in lieu of the added notes describing compatibility with different Python versions
| * | Elaborated on usage of `importlib.resources`Saniya Maheshwari2022-05-311-6/+50
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Added example package tree - Added snippet on how typically the `__file__` attribute would be used - Added snippet showing usage of `importlib.resources` with the `files()` API - Added notes on compatibility of this code with different Python versions along with references - Added snippet to show usage of `importlib_resources` backport
| * | Added note to `package_data` optionSaniya Maheshwari2022-05-311-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | In the end of the document, in the summary section, there is a line stating that the files matched by `package_data` do not require a corresponding `MANIFEST.in` or a revision control system plugin. Have included this note higher up in the document because I felt it may be of interest to users and they might miss this line so far down the document.
| * | Modified code snippets for `exclude_package_data` exampleSaniya Maheshwari2022-05-311-10/+7
| | | | | | | | | | | | | | | | | | Made them consistent with the snippets given on the Package Discovery page. The changes made here are similar to the changes made to the previous example.
| * | Elaborated on example for `exclude_package_data`Saniya Maheshwari2022-05-311-5/+6
| | | | | | | | | | | | Tried to make why this option is useful more clear.
| * | Modified code snippets for multiple top-level packages exampleSaniya Maheshwari2022-05-311-20/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Made them consistent with the snippets given on the Package Discovery page. - Instead of enumerating a list of all the packages in `packages`, using `find_packages` or `find:` instead. The `find_packages` call in `setup.py` contains a `where` argument. In `setup.cfg`, included the section `options.packages.find` with a `where` option. - Instead of supplying the same `package_dir` for each package, using an empty string to indicate a `package_dir` for all packages. - In `pyproject.toml`, using the `where` option instead of `package-dir`. - Textual changes.
| * | Treating data subdirectories as namespace packagesSaniya Maheshwari2022-05-311-21/+35
| | | | | | | | | | | | | | | | | | Modified code snippets for `package_data` example with `data` subdirectory to treat the `data` subdirectory as a namespace package. Also modified a paragraph below these snippets.
| * | Small changeSaniya Maheshwari2022-05-311-3/+2
| | | | | | | | | | | | | | | | | | | | | | | | Removed the statement within the parentheses, since the example which follows does not illustrate this specific example (of having documentation files that you may not want to include in the installation). Besides the `exclude_package_data` option covers this exact use case in a later example.
View Lorry Controller Status