Setuptools

https://setuptools.pypa.io/en/latest/
Admin
Setuptools is a stable Python library facilitating project packaging, enabling developers to easily...
Tokens:34,437
Snippets:580
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Minimal setup.py for editable installs

Source: https://setuptools.pypa.io/en/latest/references/keywords.html

Use this minimal script to ensure compatibility with editable installs when using setuptools versions older than 64.0.0 with declarative configuration.

```python
from setuptools import setup

setup()
```

--------------------------------

### Configure entry points for custom setup keywords

Source: https://setuptools.pypa.io/en/latest/userguide/extension.html

Define custom setup keywords and egg_info writers in the project configuration.

```ini
# setup.cfg
...
[options.entry_points]
distutils.setup_keywords =
    foo_bar = setuptools.dist:assert_string_list
egg_info.writers =
    foo_bar.txt = setuptools.command.egg_info:write_arg
```

--------------------------------

### Register entry point in configuration

Source: https://setuptools.pypa.io/en/latest/userguide/entry_point.html

Configuration examples for registering the plugin entry point.

```toml
# Note the quotes around timmins.display in order to escape the dot .
[project.entry-points."timmins.display"]
excl = "timmins_plugin_fancy:excl_display"
```

```ini
[options.entry_points]
timmins.display =
    excl = timmins_plugin_fancy:excl_display
```

--------------------------------

### Install setuptools via pip

Source: https://setuptools.pypa.io/en/latest/userguide/quickstart.html

Use this command to upgrade setuptools to the latest version.

```bash
pip install --upgrade setuptools[core]
```

--------------------------------

### Verify plugin installation

Source: https://setuptools.pypa.io/en/latest/userguide/entry_point.html

Check the behavior of the host package when the plugin is installed versus when it is absent.

```python
>>> from timmins import hello_world
>>> hello_world()
!!! Hello world !!!
```

```python
>>> from timmins import hello_world
>>> hello_world()
Hello world
```

--------------------------------

### Install in legacy compatibility mode

Source: https://setuptools.pypa.io/en/latest/userguide/development_mode.html

Use this command to replicate legacy editable installation behavior during the migration period.

```bash
pip install -e . --config-settings editable_mode=compat
```

--------------------------------

### Define package metadata and options in setup.cfg

Source: https://setuptools.pypa.io/en/latest/userguide/declarative_config.html

A comprehensive example of a setup.cfg file defining metadata, package options, entry points, and extras.

```ini
[metadata]
name = my_package
version = attr: my_package.VERSION
author = Josiah Carberry
author_email = josiah_carberry@brown.edu
description = My package description
long_description = file: README.rst, CHANGELOG.rst, LICENSE.rst
keywords = one, two
license = BSD-3-Clause
classifiers =
    Framework :: Django
    Programming Language :: Python :: 3

[options]
zip_safe = False
include_package_data = True
packages = find:
python_requires = >=3.8
install_requires =
    requests
    importlib-metadata; python_version<"3.10"

[options.package_data]
* = *.txt, *.rst
hello = *.msg

[options.entry_points]
console_scripts =
    executable-name = my_package.module:function

[options.extras_require]
pdf = ReportLab>=1.2; RXP
rest = docutils>=0.3; pack ==1.1, ==1.3

[options.packages.find]
exclude =
    examples*
    tools*
    docs*
    my_package.tests*
```

--------------------------------

### Install Generated Distributions

Source: https://setuptools.pypa.io/en/latest/build_meta.html

Commands to install the resulting wheel or source distribution files.

```bash
dist/
    meowpkg-0.0.1.whl
    meowpkg-0.0.1.tar.gz

$ pip install dist/meowpkg-0.0.1.whl

```

```bash
$ pip install dist/meowpkg-0.0.1.tar.gz

```

--------------------------------

### Define setup_keywords entry point

Source: https://setuptools.pypa.io/en/latest/userguide/extension.html

Register a custom setup argument in setup.cfg using the distutils.setup_keywords entry point group.

```ini
# setup.cfg
...
[options.entry_points]
distutils.commands =
     foo = mypackage.some_module:foo
distutils.setup_keywords =
    bar_baz = mypackage.some_module:validate_bar_baz
```

--------------------------------

### Example MANIFEST.in commands

Source: https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html

A basic example of using graft to include a directory and global-exclude to filter out compiled Python files.

```text
graft tests
global-exclude *.py[cod]
```

--------------------------------

### Example MANIFEST.in configuration

Source: https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html

A sample MANIFEST.in file demonstrating how to graft directories, include specific files, and globally exclude temporary or compiled files.

```text
# MANIFEST.in -- just for illustration
graft src
graft tests
graft docs
# `-> adds all files inside a directory

include tox.ini
# `-> matches file paths relative to the root of the project

global-exclude *~ *.py[cod] *.so
# `-> matches file names (regardless of directory)

```

--------------------------------

### Bootstrap setuptools in setup.py

Source: https://setuptools.pypa.io/en/latest/history.html

Use this pattern to automatically bootstrap setuptools during the installation process of a package.

```python
from ez_setup import use_setuptools
use_setuptools()

from setuptools import setup
# etc...
```

--------------------------------

### Example project directory structure

Source: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

Standard directory layout for a namespace package project.

```text
foo
├── pyproject.toml  # AND/OR setup.cfg, setup.py
└── src
    └── timmins
        ├── __init__.py
        └── foo
            └── __init__.py
```

--------------------------------

### Define entry points in setup.py

Source: https://setuptools.pypa.io/en/latest/userguide/entry_point.html

Register a plugin function under a specific entry point group within the setup configuration.

```python
from setuptools import setup

setup(
    # ...,
    entry_points = {
        'timmins.display': [
            'excl = timmins_plugin_fancy:excl_display'
        ]
    }
)
```

--------------------------------

### Project Directory Structure

Source: https://setuptools.pypa.io/en/latest/build_meta.html

Example layout for a package distribution project.

```text
~/meowpkg/
    pyproject.toml
    setup.cfg
    meowpkg/
        __init__.py
        module.py

```

--------------------------------

### Configure pkg_resources namespace in setup

Source: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

Define the namespace package in your configuration files.

```ini
[options]
namespace_packages = timmins
```

```python
setup(
    # ...
    namespace_packages=['timmins']
)
```

--------------------------------

### Project directory structure example

Source: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

A sample directory layout for a project using a src-based structure.

```text
mypkg
├── pyproject.toml  # AND/OR setup.cfg, setup.py
└── src
    ├── pkg1
    │   └── __init__.py
    ├── pkg2
    │   └── __init__.py
    ├── additional
    │   └── __init__.py
    └── pkg
        └── namespace
            └── __init__.py
```

--------------------------------

### DistributionNotFound Error Message Example

Source: https://setuptools.pypa.io/en/latest/history.html

Example of the error message format when a required distribution is missing.

```text
pkg_resources.DistributionNotFound: The 'colorama>=0.3.1' distribution was not found and is required by smlib.log.
```

--------------------------------

### Implement an egg_info writer utility

Source: https://setuptools.pypa.io/en/latest/userguide/extension.html

A utility function to write setup arguments to a file in the EGG-INFO directory.

```python
def write_arg(cmd, basename, filename):
    argname = os.path.splitext(basename)[0]
    value = getattr(cmd.distribution, argname, None)
    if value is not None:
        value = "\n".join(value) + "\n"
    cmd.write_or_delete_file(argname, filename, value)
```

--------------------------------

### Example Package Directory Structure

Source: https://setuptools.pypa.io/en/latest/userguide/datafiles.html

A sample directory layout showing where data files are located relative to the package source.

```text
project_root_directory
├── setup.py        # and/or setup.cfg, pyproject.toml
└── src
    └── mypkg
        ├── __init__.py
        ├── data1.rst
        ├── data2.rst
        ├── data1.txt
        └── data2.txt
```

--------------------------------

### Create a documentation news fragment

Source: https://setuptools.pypa.io/en/latest/development/developer-guide.html

Example of a documentation-related changelog entry file named newsfragments/2395.doc.1.rst.

```rst
Added a ``:user:`` role to Sphinx config -- by :user:`webknjaz`

```

--------------------------------

### Import package discovery functions in setup.py

Source: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

Import the necessary functions to programmatically find packages in your setup script.

```python
from setuptools import find_packages
# or
from setuptools import find_namespace_packages
```

--------------------------------

### Configure readme with content-type

Source: https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html

Example of specifying multiple files for the readme and defining a custom content-type.

```toml
readme = {file = ["README.txt", "USAGE.txt"], content-type = "text/plain"}
```

--------------------------------

### Project structure example

Source: https://setuptools.pypa.io/en/latest/userguide/ext_modules.html

A basic project layout containing a pyproject.toml file and a C source file.

```text
<project_folder>
├── pyproject.toml
└── foo.c
```

--------------------------------

### Build Distribution Packages

Source: https://setuptools.pypa.io/en/latest/build_meta.html

Commands to install the build tool and generate distribution files.

```bash
$ pip install -q build
$ python -m build

```

--------------------------------

### Set environment variable for package installation

Source: https://setuptools.pypa.io/en/latest/history.html

Use this environment variable configuration to resolve encoding issues when installing packages like numpy that reference sys.__stdout__.

```bash
PYTHONIOENCODING=utf8 pip install numpy
```

--------------------------------

### Configure Cython in setup.py

Source: https://setuptools.pypa.io/en/latest/history.html

Define an extension module and specify Cython as a setup requirement to enable on-demand downloading during the build process.

```python
ext = setuptools.Extension('mylib', ['src/CythonStuff.pyx', 'src/CStuff.c'])
setuptools.setup(
    ...
    ext_modules=[ext],
    setup_requires=['cython'],
)
```

--------------------------------

### Example EntryPoint object structure

Source: https://setuptools.pypa.io/en/latest/userguide/entry_point.html

Representation of an EntryPoint object found in the discovered list.

```python
(
    EntryPoint(name='excl', value='timmins_plugin_fancy:excl_display', group='timmins.display'),
    ...,
)
```

--------------------------------

### Configure package_data for Subdirectories

Source: https://setuptools.pypa.io/en/latest/userguide/datafiles.html

Configuration examples for including data files in subdirectories using the package_data approach.

```toml
[tool.setuptools.package-data]
mypkg = ["*.txt"]
"mypkg.data" = ["*.rst"]
```

```ini
[options]
# ...
packages = find_namespace:
package_dir =
    = src

[options.packages.find]
where = src

[options.package_data]
mypkg =
    *.txt
mypkg.data =
    *.rst
```

```python
from setuptools import setup, find_namespace_packages
setup(
    # ...,
    packages=find_namespace_packages(where="src"),
    package_dir={"": "src"},
    package_data={
        "mypkg": ["*.txt"],
        "mypkg.data": ["*.rst"],
    }
)
```

--------------------------------

### Configure include_package_data for Subdirectories

Source: https://setuptools.pypa.io/en/latest/userguide/datafiles.html

Configuration examples for including data files in subdirectories using the include_package_data approach.

```toml
[tool.setuptools]
# ...
# By default, include-package-data is true in pyproject.toml, so you do
# NOT have to specify this line.
include-package-data = true

[tool.setuptools.packages.find]
# scanning for namespace packages is true by default in pyproject.toml, so
# you need NOT include this configuration.
namespaces = true
where = ["src"]
```

```ini
[options]
packages = find_namespace:
package_dir =
    = src
include_package_data = True

[options.packages.find]
where = src
```

```python
from setuptools import setup, find_namespace_packages
setup(
    # ... ,
    packages=find_namespace_packages(where="src"),
    package_dir={"": "src"},
    include_package_data=True,
)
```

--------------------------------

### Build and Rotate Distributions

Source: https://setuptools.pypa.io/en/latest/userguide/distribution.html

Example command to generate an egg with a development tag and retain only the three most recent files.

```bash
setup.py egg_info -rbDEV bdist_egg rotate -m.egg -k3
```

--------------------------------

### Project Directory Structure Example

Source: https://setuptools.pypa.io/en/latest/userguide/datafiles.html

A visual representation of a project layout where data files are organized in a subdirectory.

```text
project_root_directory
├── setup.py        # and/or setup.cfg, pyproject.toml
└── src
    └── mypkg
        ├── data
        │   ├── data1.rst
        │   └── data2.rst
        ├── __init__.py
        ├── data1.txt
        └── data2.txt
```

--------------------------------

### Generated wrapper script logic

Source: https://setuptools.pypa.io/en/latest/userguide/entry_point.html

Internal logic used by installers to invoke the entry point function.

```python
import sys
from timmins import hello_world
sys.exit(hello_world())
```

--------------------------------

### Perform an editable installation

Source: https://setuptools.pypa.io/en/latest/userguide/development_mode.html

Use the pip --editable flag within a virtual environment to link the project for iterative development.

```bash
$ cd your-python-project
$ python -m venv .venv
# Activate your environment with:
#      `source .venv/bin/activate` on Unix/macOS
# or   `.venv\Scripts\activate` on Windows

$ pip install --editable .

# Now you have access to your package
# as if it was installed in .venv
$ python -c "import your_python_project"
```

--------------------------------

### Launch distutils-only packages with setuptools

Source: https://setuptools.pypa.io/en/latest/history.html

Use this command to invoke setuptools monkeypatching of distutils before running a script, similar to how pip handles package installation.

```bash
$ python -m setuptools.launch setup.py develop
```

--------------------------------

### Configure build-system and project license

Source: https://setuptools.pypa.io/en/latest/userguide/license_migration.html

Declare the minimum setuptools version and define the project license using SPDX identifiers.

```toml
[build-system]
requires = ["setuptools>=77"]
build-backend = "setuptools.build_meta"

[project]
name = "my_package"
license = "Apache-2.0"
license-files = ["LICENSE"]
```

--------------------------------

### Install build tool via pip

Source: https://setuptools.pypa.io/en/latest/userguide/quickstart.html

Install the build package to automate the download of build-time dependencies.

```bash
pip install --upgrade build
```

--------------------------------

### Install python3-venv on Debian/Ubuntu

Source: https://setuptools.pypa.io/en/latest/userguide/development_mode.html

Install the venv module using the system package manager if it is not available by default.

```bash
sudo apt install python3-venv
```

--------------------------------

### Configure package discovery in setup.cfg

Source: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

Use the [options] section to specify whether to use find or find_namespace for package discovery.

```ini
[options]
packages = find:
#or
packages = find_namespace:
```

--------------------------------

### Install package in editable mode

Source: https://setuptools.pypa.io/en/latest/userguide/quickstart.html

Install a package in development mode to allow source code changes to take effect without reinstalling.

```bash
pip install --editable .
```

--------------------------------

### Configure src-layout in setup.cfg

Source: https://setuptools.pypa.io/en/latest/userguide/declarative_config.html

Use package_dir and packages.find to point setuptools to a src subdirectory.

```ini
[options]
package_dir=
    =src
packages=find:

[options.packages.find]
where=src
```

--------------------------------

### Enable strict editable mode with pip

Source: https://setuptools.pypa.io/en/latest/userguide/development_mode.html

Use this command to install a package in strict editable mode, which mimics regular installation behavior.

```bash
pip install -e . --config-settings editable_mode=strict
```

--------------------------------

### setuptools.Extension

Source: https://setuptools.pypa.io/en/latest/userguide/ext_modules.html

The Extension class describes a single extension module, specifying source files, compiler options, and linker settings required to build the binary.

```APIDOC
## class setuptools.Extension

### Description
Describes a single extension module. All source files provided are compiled into a single binary file.

### Constructor
`setuptools.Extension(name, sources, *args, py_limited_api=False, **kw)`

### Parameters
- **name** (str) - Required - The full dotted Python name of the extension.
- **sources** (Iterable[str | PathLike[str]]) - Required - Iterable of source filenames relative to the distribution root.
- **include_dirs** (list[str]) - Optional - Directories to search for C/C++ header files.
- **define_macros** (list[tuple[str, str | None]]) - Optional - Macros to define.
- **undef_macros** (list[str]) - Optional - Macros to undefine.
- **library_dirs** (list[str]) - Optional - Directories to search for libraries at link time.
- **libraries** (list[str]) - Optional - Library names to link against.
- **runtime_library_dirs** (list[str]) - Optional - Directories to search for libraries at run time.
- **extra_objects** (list[str]) - Optional - Extra files to link with.
- **extra_compile_args** (list[str]) - Optional - Platform/compiler-specific compilation arguments.
- **extra_link_args** (list[str]) - Optional - Platform/compiler-specific linking arguments.
- **export_symbols** (list[str]) - Optional - Symbols to export from a shared extension.
- **swig_opts** (list[str]) - Optional - Options for SWIG if using .i files.
- **depends** (list[str]) - Optional - Files that the extension depends on.
- **language** (str) - Optional - Extension language (e.g., 'c', 'c++', 'objc').
- **optional** (bool) - Optional - If True, build failure does not abort the installation.
- **py_limited_api** (bool) - Optional - Opt-in flag for Python's limited API.

### Raises
- **setuptools.errors.PlatformError** - Raised if `runtime_library_dirs` is specified on Windows.
```

--------------------------------

### Implement Custom Build Backend Wrapper

Source: https://setuptools.pypa.io/en/latest/build_meta.html

A wrapper script for setuptools.build_meta to dynamically handle build requirements.

```python
from setuptools import build_meta as _orig
from setuptools.build_meta import *


def get_requires_for_build_wheel(config_settings=None):
    return _orig.get_requires_for_build_wheel(config_settings) + [...]


def get_requires_for_build_sdist(config_settings=None):
    return _orig.get_requires_for_build_sdist(config_settings) + [...]

```

--------------------------------

### Invoke installed console script

Source: https://setuptools.pypa.io/en/latest/userguide/entry_point.html

Running the newly created command from the terminal.

```bash
$ hello-world
Hello world
```

--------------------------------

### Use interpolation in setup.cfg

Source: https://setuptools.pypa.io/en/latest/userguide/declarative_config.html

Reference existing configuration values within the same file using the %(key)s syntax.

```ini
[options.extras_require]
tester =
    pytest==3.3.2
    pytest-sugar
dev =
    pytest-xdist
    %(tester)s
```

--------------------------------

### Configure setup.cfg Metadata

Source: https://setuptools.pypa.io/en/latest/build_meta.html

Declarative configuration for package metadata and options.

```ini
[metadata]
name = meowpkg
version = 0.0.1
description = a package that meows

[options]
packages = find:

```

--------------------------------

### Format complex values in setup.cfg

Source: https://setuptools.pypa.io/en/latest/userguide/declarative_config.html

Demonstrates equivalent ways to define multi-value configuration keys using comma-separated or dangling line formats.

```ini
[metadata]
keywords = one, two

[metadata]
keywords =
    one
    two
```

--------------------------------

### Build Documentation Locally

Source: https://setuptools.pypa.io/en/latest/development/developer-guide.html

Generate the project documentation locally using the tox environment.

```bash
$ tox -e docs
```

--------------------------------

### Configure namespace package discovery in setup.py

Source: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

Use find_namespace_packages() to scan all directories for packages.

```python
setup(
    # ...
    packages=find_namespace_packages(where='src'),
    package_dir={"": "src"}
    # ...
)
```

--------------------------------

### Include specific packages in setup.cfg

Source: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

Configure package discovery to include only packages matching a pattern within a source directory.

```ini
[options]
packages = find:
package_dir =
    =src

[options.packages.find]
where = src
include = pkg*
# alternatively: `exclude = additional*`
```

--------------------------------

### Define a GUI script function

Source: https://setuptools.pypa.io/en/latest/userguide/entry_point.html

Example function to be invoked by a GUI script entry point.

```python
import PySimpleGUI as sg

def hello_world():
    sg.Window(title="Hello world", layout=[[]], margins=(100, 50)).read()
```

--------------------------------

### Create a feature news fragment

Source: https://setuptools.pypa.io/en/latest/development/developer-guide.html

Example of a feature-category changelog entry file named newsfragments/2355.feature.rst.

```rst
When pip is imported as part of a build, leave :py:mod:`distutils`
patched -- by :user:`jaraco`

```

--------------------------------

### Registering a custom command in setup.cfg

Source: https://setuptools.pypa.io/en/latest/userguide/extension.html

Define a new command by adding an entry point to the distutils.commands group in your project's configuration file.

```ini
# setup.cfg
...
[options.entry_points]
distutils.commands =
     foo = mypackage.some_module:foo
```

--------------------------------

### Create a miscellaneous news fragment

Source: https://setuptools.pypa.io/en/latest/development/developer-guide.html

Example of a miscellaneous-category changelog entry file named newsfragments/1354.misc.rst.

```rst
Added ``towncrier`` for changelog management -- by :user:`pganssle`

```

--------------------------------

### Configure pyproject.toml for setuptools

Source: https://setuptools.pypa.io/en/latest/build_meta.html

Defines the build system requirements and backend for setuptools.

```toml
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

```

--------------------------------

### Invoke setup.py with setuptools import

Source: https://setuptools.pypa.io/en/latest/history.html

Ensures setuptools is imported before executing setup.py to avoid legacy distutils behavior.

```bash
python -c "import setuptools; exec(open('setup.py').read())" (anything)
```

--------------------------------

### Use find directive for packages

Source: https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html

Example of using the find directive to specify package locations and exclusions.

```toml
{find = {where = ["src"], exclude=["tests*"]}}
```

--------------------------------

### Configure license-files with Glob Patterns

Source: https://setuptools.pypa.io/en/latest/userguide/license_migration.html

Illustrates using glob patterns to include multiple license or notice files.

```toml
license-files = ["LICENSE*", "NOTICE"]
```

--------------------------------

### Use attr directive for version

Source: https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html

Example of using the attr directive to point to a module attribute for dynamic versioning.

```toml
{attr = "mymodule.attr"}
```

--------------------------------

### Exclude package data configuration

Source: https://setuptools.pypa.io/en/latest/userguide/datafiles.html

Examples of how to configure file exclusions across different project configuration formats.

```toml
[tool.setuptools.packages.find]
where = ["src"]

[tool.setuptools.exclude-package-data]
mypkg = [".gitattributes"]
```

```ini
[options]
# ...
packages = find:
package_dir =
    = src
include_package_data = True

[options.packages.find]
where = src

[options.exclude_package_data]
mypkg =
    .gitattributes
```

```python
from setuptools import setup, find_packages
setup(
    # ...,
    packages=find_packages(where="src"),
    package_dir={"": "src"},
    include_package_data=True,
    exclude_package_data={"mypkg": [".gitattributes"]},
)
```

--------------------------------

### Include specific packages in setup.py

Source: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

Use find_packages with include or exclude arguments to filter discovered packages.

```python
setup(
    # ...
    packages=find_packages(
        where='src',
        include=['pkg*'],  # alternatively: `exclude=['additional*']`
    ),
    package_dir={"": "src"}
    # ...
)
```

--------------------------------

### Declare platform-specific dependencies

Source: https://setuptools.pypa.io/en/latest/userguide/dependency_management.html

Use environment markers to conditionally install packages based on Python version or operating system.

```toml
[project]
# ...
dependencies = [
    "enum34; python_version<'3.4'",
]
# ...
```

```ini
[options]
#...
install_requires =
    enum34;python_version<'3.4'
```

```python
setup(
    ...,
    install_requires=[
        "enum34;python_version<'3.4'",
    ],
)
```

--------------------------------

### Register a file finder plugin in setup.cfg

Source: https://setuptools.pypa.io/en/latest/userguide/extension.html

Register the file finder function under the setuptools.file_finders entry point group in the project configuration.

```ini
# setup.cfg
...

[options.entry_points]
setuptools.file_finders =
    foobar = my_foobar_module:find_files_for_foobar
```

--------------------------------

### Configure namespace package discovery in setup.cfg

Source: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

Use find_namespace: in the packages option to include directories without __init__.py files.

```ini
[options]
package_dir =
    =src
packages = find_namespace:

[options.packages.find]
where = src
```

--------------------------------

### Entry Point Syntax Definition

Source: https://setuptools.pypa.io/en/latest/userguide/entry_point.html

The standard format for defining an entry point in configuration files.

```text
<name> = <package_or_module>[:<object>[.<attr>[.<nested-attr>]*]]
```

--------------------------------

### Implement a file finder function for setuptools

Source: https://setuptools.pypa.io/en/latest/userguide/extension.html

Define a function that accepts a directory name and yields relative paths of files tracked by the revision control system.

```python
def find_files_for_foobar(dirname):
    ...  # loop to yield paths that start with `dirname`
```

--------------------------------

### Parse configuration with read_configuration

Source: https://setuptools.pypa.io/en/latest/setuptools.html

Reads metadata and options from a setup.cfg file into a dictionary.

```python
from setuptools.config import read_configuration

conf_dict = read_configuration("/home/user/dev/package/setup.cfg")
```
Tokens:
Raw