Service Dev

class dffml.service.dev.Bump(extra_config=None, **kwargs)

Bump the the main package in the versions plugins, or any or all libraries.

inter

alias of dffml.service.dev.BumpInter

packages

alias of dffml.service.dev.BumpPackages

class dffml.service.dev.BumpInter(extra_config=None, **kwargs)

Bump the version number of other plugins within the dependency list of each plugin. This is for interdependent plugins.

class dffml.service.dev.BumpPackages(extra_config=None, **kwargs)

Bump all the versions of all the packages and increment the version number given.

CONFIG

alias of dffml.service.dev.BumpPackagesConfig

class dffml.service.dev.BumpPackagesConfig(version: str, skip: List[str] = <factory>, only: List[str] = <factory>)

no_enforce_immutable()

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.service.dev.CI(extra_config=None, **kwargs)

CI related commands

exception dffml.service.dev.CommitLintError

class dffml.service.dev.Create(extra_config=None, **kwargs)

Create new models, operations, etc.

class dffml.service.dev.Develop(extra_config=None, **kwargs)

Development utilities for hacking on DFFML itself

bump

alias of dffml.service.dev.Bump

ci

alias of dffml.service.dev.CI

create

alias of dffml.service.dev.Create

docs

alias of dffml.service.dev.MakeDocs

install

alias of dffml.service.dev.Install

lint

alias of dffml.service.dev.Lint

release

alias of dffml.service.dev.Release

run

alias of dffml.service.dev.Run

skel

alias of dffml.service.dev.Skeleton

class dffml.service.dev.ExportConfig(export: str, configloader: dffml.configloader.configloader.BaseConfigLoader = <class 'dffml.configloader.json.JSONConfigLoader'>, not_linked: bool = False)

no_enforce_immutable()

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.service.dev.Install(extra_config=None, **kwargs)

Uninstall production packages and install dffml in development mode.

CONFIG

alias of dffml.service.dev.InstallConfig

static dep_check(plugin_deps: Dict[Tuple[str, str], Dict[str, Callable[[], bool]]], skip: Optional[List[Tuple[str, str]]] = None)

Check if all dependencies are installed prior to running setup.py installs of plugins

class dffml.service.dev.InstallConfig(skip: List[str] = <factory>, nocheck: bool = False, user: bool = False)

no_enforce_immutable()

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.service.dev.Link(extra_config=None, **kwargs)

Create required symlinks from skel/common to the other template directories

class dffml.service.dev.Lint(extra_config=None, **kwargs)

Linting related commands

commits

alias of dffml.service.dev.LintCommits

class dffml.service.dev.LintCommits(extra_config=None, **kwargs)

Enforce commit message style

class dffml.service.dev.ListEntrypointsConfig(entrypoint: str)

no_enforce_immutable()

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.service.dev.MakeDocs(extra_config=None, **kwargs)

Generate docs of the complete package

CONFIG

alias of dffml.service.dev.MakeDocsConfig

class dffml.service.dev.MakeDocsConfig(target: pathlib.Path = None, port: int = 8080, http: bool = False, no_strict: bool = False)

no_enforce_immutable()

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

exception dffml.service.dev.MissingDependenciesError

Raised when a package has non-pip installable dependencies, or pip installable dependencies that must be installed before running the setup.py

exception dffml.service.dev.RCMissingHyphen

class dffml.service.dev.Release(extra_config=None, **kwargs)

Release a package (if not already released)

CONFIG

alias of dffml.service.dev.ReleaseConfig

class dffml.service.dev.ReleaseConfig(package: pathlib.Path)

no_enforce_immutable()

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

exception dffml.service.dev.RepoDirtyError

Raised when a release was attempted but there are uncommitted changes

class dffml.service.dev.Run(extra_config=None, **kwargs)

Run a single operation

CONFIG

alias of dffml.service.dev.RunConfig

class dffml.service.dev.RunConfig(operation: str)

no_enforce_immutable()

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.service.dev.SetupPyKWArg(extra_config=None, **kwargs)

Get a keyword argument from a call to setup in a setup.py file.

CONFIG

alias of dffml.service.dev.SetupPyKWArgConfig

class dffml.service.dev.SetupPyKWArgConfig(kwarg: str, setupfilepath: str)

no_enforce_immutable()

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.service.dev.SetupPyVersion(extra_config=None, **kwargs)

Read a version.py file that would be referenced by a setup.py or setup.cfg. The version.py file contains the version of the package in the VERSION variable.

CONFIG

alias of dffml.service.dev.SetupPyVersionConfig

class dffml.service.dev.SetupPyVersionConfig(versionfilepath: str)

no_enforce_immutable()

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.service.dev.Skeleton(extra_config=None, **kwargs)

Work with the skeleton directories (create service templates)

link

alias of dffml.service.dev.Link

exception dffml.service.dev.SphinxBuildError

Raised when sphinx-build command exits with a non-zero error code.

exception dffml.service.dev.VersionNotFoundError

Raised when a version.py file is parsed and no VERSION variable is found.

dffml.service.dev.create_from_skel(plugin_type)

Copies samples out of skel/ and does re-naming.