Skip to content

Commit 4113e8a

Browse files
committed
Rename entrypoint to ansys.tools.common.launcher
1 parent 5351178 commit 4113e8a

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

doc/source/user_guide/launcher/plugin_creation.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -190,15 +190,15 @@ You define the entrypoint in your package's build configuration. The exact synta
190190

191191
.. code:: toml
192192
193-
[project.entry-points."ansys.tools.common.launcher.launcher"]
193+
[project.entry-points."ansys.tools.common.launcher"]
194194
"ACP.direct" = "<your.module.name>:DirectLauncher"
195195
196196
In a ``setup.cfg`` file:
197197

198198
.. code:: cfg
199199
200200
[options.entry_points]
201-
ansys.tools.common.launcher.launcher =
201+
ansys.tools.common.launcher =
202202
ACP.direct = <your.module.name>:DirectLauncher
203203
204204
In a ``setup.py`` file:
@@ -210,7 +210,7 @@ You define the entrypoint in your package's build configuration. The exact synta
210210
setup(
211211
# ...,
212212
entry_points={
213-
"ansys.tools.common.launcher.launcher": [
213+
"ansys.tools.common.launcher": [
214214
"ACP.direct = <your.module.name>:DirectLauncher"
215215
]
216216
}
@@ -225,7 +225,7 @@ You define the entrypoint in your package's build configuration. The exact synta
225225

226226
.. code:: toml
227227
228-
[project.entry-points."ansys.tools.common.launcher.launcher"]
228+
[project.entry-points."ansys.tools.common.launcher"]
229229
"ACP.direct" = "<your.module.name>:DirectLauncher"
230230
231231
For more information, see the `Entry points sections <https://flit.pypa.io/en/stable/pyproject_toml.html#pyproject-project-entrypoints>`_ in the Flit documentation.
@@ -236,12 +236,12 @@ You define the entrypoint in your package's build configuration. The exact synta
236236

237237
.. code:: toml
238238
239-
[tool.poetry.plugins."ansys.tools.common.launcher.launcher"]
239+
[tool.poetry.plugins."ansys.tools.common.launcher"]
240240
"ACP.direct" = "<your.module.name>:DirectLauncher"
241241
242242
For more information, see the `plugins <https://python-poetry.org/docs/pyproject#plugins>`_ in the Poetry documentation.
243243

244-
In all cases, ``ansys.tools.common.launcher.launcher`` is an identifier specifying that the entrypoint defines a local product launcher plugin. It must be kept the same.
244+
In all cases, ``ansys.tools.common.launcher`` is an identifier specifying that the entrypoint defines a local product launcher plugin. It must be kept the same.
245245

246246
The entrypoint itself has two parts:
247247

@@ -316,7 +316,7 @@ For example, to make ``DirectLauncher`` the fallback for ACP, add this entry poi
316316

317317
.. code:: toml
318318
319-
[project.entry-points."ansys.tools.common.launcher.launcher"]
319+
[project.entry-points."ansys.tools.common.launcher"]
320320
"ACP.__fallback__" = "<your.module.name>:DirectLauncher"
321321
322322
The fallback launch mode is used with its default configuration. This means that the configuration class must have default values for all its fields.

src/ansys/tools/common/launcher/_plugins.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
from .interface import FALLBACK_LAUNCH_MODE_NAME, DataclassProtocol, LauncherProtocol
3232

33-
LAUNCHER_ENTRY_POINT = "ansys.tools.common.launcher.launcher"
33+
LAUNCHER_ENTRY_POINT = "ansys.tools.common.launcher"
3434

3535

3636
def get_launcher(*, product_name: str, launch_mode: str) -> type[LauncherProtocol[DataclassProtocol]]:

tests/launcher/pkg_with_entrypoint/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ packages = [
1616
[tool.poetry.dependencies]
1717
python = ">=3.10,<4.0"
1818

19-
[tool.poetry.plugins."ansys.tools.common.launcher.launcher"]
19+
[tool.poetry.plugins."ansys.tools.common.launcher"]
2020
"pkg_with_entrypoint.test_entry_point" = "pkg_with_entrypoint:Launcher"
2121
"pkg_with_entrypoint.__fallback__" = "pkg_with_entrypoint:Launcher"

0 commit comments

Comments
 (0)