Module `pluginconf.setup`

Expands setuptools.setup() with automatic package description lookup

Functions

def get_readme()

get README.md contents

def name_to_fn(name)

find primary entry point.py from package name

def setup(filename=None, debug=False, **kwargs)

Wrapper around setuptools.setup() which adds some defaults and plugin meta data import, with some shortcut parameters:

Parameters
filename	str	main file "pkg/main.py" (else deduced from primary package name)
debug	bool	display collected options prior setuptools.setup() invocation
long_description	str	e.g. "README.md", else the comment block gets used

Other setup() params work as usual, and are passed trough. Notably entry_points= or data_files= can be used, even if they get augmented.

class MetaUtils (*args, **kwargs)

Convenience access to PMD fields and conversion functions