spec.Consumer

spec.Consumer(ref, kind, note='')

Something that depends on a unit and would notice its deletion.

Attributes

Name Type Description
ref str A repository-relative path, or a free-text name for operational and human dependents.
kind str One of code, test, script, book, doc (files in this repository), external (a file in a downstream repository, written <repo>:<path>), operational or human. Only the first five are checked against the tree.
note str What the consumer relies on.

Examples

from spotregen import Consumer

consumer = Consumer(ref="src/samplepkg/app/main.py", kind="code", note="sums values")
print(consumer.ref, consumer.kind)
src/samplepkg/app/main.py code