diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2020-10-17 13:14:24 -0400 |
|---|---|---|
| committer | Jason R. Coombs <jaraco@jaraco.com> | 2020-10-17 13:14:24 -0400 |
| commit | 9ab7bc54cf1eb1a0cb088e8157dc8c88c553b9c7 (patch) | |
| tree | 5617a67cb2b1397c72c9c06307017c184d82982b | |
| parent | 7ff173926c4773d39f3320ff0c9d65afb290e7b1 (diff) | |
| download | python-setuptools-git-9ab7bc54cf1eb1a0cb088e8157dc8c88c553b9c7.tar.gz | |
Clean up syntax on entry_points.console_scripts. Fixes #2429.
| -rw-r--r-- | docs/userguide/quickstart.rst | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index aebcf60f..697087ed 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -106,16 +106,15 @@ use, go to :ref:`package_discovery` Entry points and automatic script creation =========================================== Setuptools support automatic creation of scripts upon installation, that runs -code within your package if you specify them with the ``entry_point`` keyword. +code within your package if you specify them with the ``entry_points`` keyword. This is what allows you to run commands like ``pip install`` instead of having to type ``python -m pip install``. To accomplish this, add the entry_points keyword in your ``setup.cfg``: .. code-block:: ini - [options] - entry_points = - [console_script] + [options.entry_points] + console_scripts = main = mypkg:some_func When this project is installed, a ``main`` script will be installed and will |