diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-03-24 11:53:37 +0000 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-03-24 11:53:37 +0000 |
| commit | 9bc0c4a26f82940c213fb07de5e6ebce0b65dd87 (patch) | |
| tree | fb2247d83befcada0a254bbea33281d72a51b8db /docs | |
| parent | 4def932c937ffab43f4a9eea5aa57ad0d1a18272 (diff) | |
| download | python-setuptools-git-9bc0c4a26f82940c213fb07de5e6ebce0b65dd87.tar.gz | |
Add module to entry_point example in quickstart
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/userguide/quickstart.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index 67c4bc81..4a24f337 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -202,7 +202,7 @@ The following configuration examples show how to accomplish this: [options.entry_points] console_scripts = - cli-name = mypkg:some_func + cli-name = mypkg.mymodule:some_func .. tab:: setup.py [#setup.py]_ @@ -212,7 +212,7 @@ The following configuration examples show how to accomplish this: # ... entry_points={ 'console_scripts': [ - 'cli-name = mypkg:some_func', + 'cli-name = mypkg.mymodule:some_func', ] } ) @@ -222,11 +222,11 @@ The following configuration examples show how to accomplish this: .. code-block:: toml [project.scripts] - cli-name = mypkg:some_func + cli-name = mypkg.mymodule:some_func When this project is installed, a ``cli-name`` executable will be created. ``cli-name`` will invoke the function ``some_func`` in the -``mypkg/__init__.py`` file when called by the user. +``mypkg/mymodule.py`` file when called by the user. Note that you can also use the ``entry-points`` mechanism to advertise components between installed packages and implement plugin systems. For detailed usage, go to :doc:`entry_point`. |