summaryrefslogtreecommitdiff
path: root/docs/userguide/entry_point.rst
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2022-06-16 21:59:01 +0100
committerAnderson Bravalheri <andersonbravalheri@gmail.com>2022-06-16 21:59:01 +0100
commit9d487039eaab63eda2283c69653ef1b09ccf702d (patch)
treec4ac1007e69496f3dc898753b42070097511002c /docs/userguide/entry_point.rst
parent9c7163bc6030e546ba1133de823d0b4ac06a02d9 (diff)
downloadpython-setuptools-git-9d487039eaab63eda2283c69653ef1b09ccf702d.tar.gz
docs: Reorder example tabs
Diffstat (limited to 'docs/userguide/entry_point.rst')
-rw-r--r--docs/userguide/entry_point.rst68
1 files changed, 34 insertions, 34 deletions
diff --git a/docs/userguide/entry_point.rst b/docs/userguide/entry_point.rst
index bad083f4..eff20cf0 100644
--- a/docs/userguide/entry_point.rst
+++ b/docs/userguide/entry_point.rst
@@ -29,7 +29,7 @@ First consider an example without entry points. Imagine a package
defined thus::
project_root_directory
- ├── setup.py # and/or setup.cfg, pyproject.toml
+ ├── pyproject.toml # and/or setup.cfg, setup.py
└── src
└── timmins
├── __init__.py
@@ -69,6 +69,13 @@ In the above example, to create a command ``hello-world`` that invokes
``timmins.hello_world``, add a console script entry point to your
configuration:
+.. tab:: pyproject.toml
+
+ .. code-block:: toml
+
+ [project.scripts]
+ hello-world = "timmins:hello_world"
+
.. tab:: setup.cfg
.. code-block:: ini
@@ -92,13 +99,6 @@ configuration:
}
)
-.. tab:: pyproject.toml
-
- .. code-block:: toml
-
- [project.scripts]
- hello-world = "timmins:hello_world"
-
After installing the package, a user may invoke that function by simply calling
``hello-world`` on the command line:
@@ -139,6 +139,13 @@ with an ``__init__.py`` file containing the following:
Then, we can add a GUI script entry point:
+.. tab:: pyproject.toml
+
+ .. code-block:: toml
+
+ [project.gui-scripts]
+ hello-world = "timmins:hello_world"
+
.. tab:: setup.cfg
.. code-block:: ini
@@ -150,7 +157,7 @@ Then, we can add a GUI script entry point:
.. tab:: setup.py
.. code-block:: python
-
+
from setuptools import setup
setup(
@@ -162,13 +169,6 @@ Then, we can add a GUI script entry point:
}
)
-.. tab:: pyproject.toml
-
- .. code-block:: toml
-
- [project.gui-scripts]
- hello-world = "timmins:hello_world"
-
.. note::
To be able to import ``PySimpleGUI``, you need to add ``pysimplegui`` to your package dependencies.
See :doc:`/userguide/dependency_management` for more information.
@@ -236,7 +236,7 @@ corresponding to plugins. Say we have a package ``timmins`` with the following
directory structure::
timmins
- ├── setup.py # and/or setup.cfg, pyproject.toml
+ ├── pyproject.toml # and/or setup.cfg, setup.py
└── src
└── timmins
└── __init__.py
@@ -328,7 +328,7 @@ which implements the entry point ``timmins.display``. Let us name this plugin
``timmins-plugin-fancy``, and set it up with the following directory structure::
timmins-plugin-fancy
- ├── setup.py # and/or setup.cfg, pyproject.toml
+ ├── pyproject.toml # and/or setup.cfg, setup.py
└── src
└── timmins_plugin_fancy
└── __init__.py
@@ -345,6 +345,14 @@ This is the ``display()``-like function that we are looking to supply to the
``timmins`` package. We can do that by adding the following in the configuration
of ``timmins-plugin-fancy``:
+.. tab:: pyproject.toml
+
+ .. code-block:: toml
+
+ # Note the quotes around timmins.display in order to escape the dot .
+ [project.entry-points."timmins.display"]
+ excl = "timmins_plugin_fancy:excl_display"
+
.. tab:: setup.cfg
.. code-block:: ini
@@ -368,14 +376,6 @@ of ``timmins-plugin-fancy``:
}
)
-.. tab:: pyproject.toml
-
- .. code-block:: toml
-
- # Note the quotes around timmins.display in order to escape the dot .
- [project.entry-points."timmins.display"]
- excl = "timmins_plugin_fancy:excl_display"
-
Basically, this configuration states that we are a supplying an entry point
under the group ``timmins.display``. The entry point is named ``excl`` and it
refers to the function ``excl_display`` defined by the package ``timmins-plugin-fancy``.
@@ -416,6 +416,14 @@ functions, as follows:
The configuration of ``timmins-plugin-fancy`` would then change to:
+.. tab:: pyproject.toml
+
+ .. code-block:: toml
+
+ [project.entry-points."timmins.display"]
+ excl = "timmins_plugin_fancy:excl_display"
+ lined = "timmins_plugin_fancy:lined_display"
+
.. tab:: setup.cfg
.. code-block:: ini
@@ -441,14 +449,6 @@ The configuration of ``timmins-plugin-fancy`` would then change to:
}
)
-.. tab:: pyproject.toml
-
- .. code-block:: toml
-
- [project.entry-points."timmins.display"]
- excl = "timmins_plugin_fancy:excl_display"
- lined = "timmins_plugin_fancy:lined_display"
-
On the ``timmins`` side, we can also use a different strategy of loading entry
points. For example, we can search for a specific display style: