diff options
| author | Géry Ogam <gery.ogam@gmail.com> | 2022-07-25 08:11:03 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-25 08:11:03 +0200 |
| commit | 0d3843dc44cf2ab843bea7d8e813f05effde5b2f (patch) | |
| tree | cfd9a046567bc15a1d9344920056bffb17916c07 /docs | |
| parent | 417018d3299bb33e87d2fccec48790cf3e9dd797 (diff) | |
| download | python-setuptools-git-0d3843dc44cf2ab843bea7d8e813f05effde5b2f.tar.gz | |
Update quickstart.rst
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/userguide/quickstart.rst | 21 |
1 files changed, 9 insertions, 12 deletions
diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index 6c39c352..e45bde0e 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -186,14 +186,12 @@ found, as shown in the example below: .. code-block:: ini [options] - packages = find: # OR `find_namespaces:` if you want to use namespaces + packages = find: # OR `find_namespaces:` if you want to use namespaces - [options.packages.find] # (always `find` even if `find_namespaces:` was used before) - # This section is optional - # Each entry in this section is optional, and if not specified, the default values are: - # `where=.`, `include=*` and `exclude=` (empty). - include=mypackage* - exclude=mypackage.tests* + [options.packages.find] # (always `find` even if `find_namespaces:` was used before) + where=src # . by default + include=mypackage* # * by default + exclude=mypackage.tests* # empty by default .. tab:: setup.py [#setup.py]_ @@ -204,18 +202,17 @@ found, as shown in the example below: setup( # ... packages=find_packages( - where='.', - include=['mypackage*'], # ["*"] by default + where='src', # '.' by default + include=['mypackage*'], # ['*'] by default exclude=['mypackage.tests'], # empty by default ), # ... ) When you pass the above information, alongside other necessary information, -``setuptools`` walks through the directory specified in ``where`` (omitted -here as the package resides in the current directory) and filters the packages +``setuptools`` walks through the directory specified in ``where`` (defaults to ``.``) and filters the packages it can find following the ``include`` patterns (defaults to ``*``), then it removes -those that match the ``exclude`` patterns and returns a list of Python packages. +those that match the ``exclude`` patterns (defaults to empty) and returns a list of Python packages. For more details and advanced use, go to :ref:`package_discovery`. |