Module pluginconf.setup
Simulates setuptools.setup()
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 comment block 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.
Classes
class MetaUtils (*args, **kwargs)
-
convenience access to PMD fields
Ancestors
- builtins.dict
Static methods
def datafiles_man()
-
data_files=
Methods
def classifiers(self)
-
classifiers: / keywords: / category:
def entry_points(self)
-
collect console-scripts:
def extras_require(self)
-
suggest: line
def get_keywords(self)
-
keywords=
def install_requires(self)
-
depends: python:module, pip:module
def plugin_doc(self)
-
use comment block
def project_urls(self, exclude=('url', 'update'))
-
other-url: https://...
def python_requires(self)
-
depends: python >= 3.5
def trove_license(self)
-
license: to License ::
def trove_status(self)
-
state: to DevStatus ::