Configuration
This page describes how to configure pydistcheck.
pydistscheck resolves different sources of configuration in the following order.
default values
CLI arguments
pydistcheck
Run the contents of a distribution through a set of checks, and warn about any problematic characteristics that are detected.
pydistcheck [OPTIONS] [FILEPATHS]...
Options
- --ignore <ignore>
comma-separated list of checks to skip, e.g.
distro-too-large-compressed,path-contains-spaces.
- --inspect
print diagnostic information about the distribution
- --max-allowed-files <max_allowed_files>
maximum number of files allowed in the distribution
- Default:
2000
- --max-allowed-size-compressed <max_allowed_size_compressed>
maximum allowed compressed size, a string like ‘1.5M’ indicating ‘1.5 megabytes’. Supported units: - B = bytes - K = kilobytes - M = megabytes - G = gigabytes
- Default:
50M
- --max-allowed-size-uncompressed <max_allowed_size_uncompressed>
maximum allowed uncompressed size, a string like ‘1.5M’ indicating ‘1.5 megabytes’. Supported units: - B = bytes - K = kilobytes - M = megabytes - G = gigabytes
- Default:
75M
Arguments
- FILEPATHS
Optional argument(s)
pyproject.toml
If a file pyproject.toml exists in the working directory pydistcheck is run from, pydistcheck will look there for configuration.
Put configuration in a [tool.pydistcheck] section, like the following example.
[tool.pydistcheck]
inspect = False
max_allowed_size_compressed = '1G'
max_allowed_size_uncompressed = '4.5G'