protoprimer_dictionary

This doc defines terms used in the vocabulary of protoprimer project.

"entry script"

See entry_script.

"client code"

Phrase "client code" refers to the software project which relies on the protoprimer as a dependency.

"main function"

This is just a pattern in python to factor __main__ part into a main function - see more info.

"proto code"

proto_code is a copy of protoprimer.primer_kernel module stored together with the client code.

TODO: (add an option to rename) It is normally named as proto_kernel.py to disambiguate from protoprimer.primer_kernel.

See proto_code.

"ref root"

The directory inside client code that is used as the base to specify most of the relative paths against.

For many projects, it is natural to suggest that ref root = repo root. However, it may not always be the case (hence, the different name):

  • some repo may use a nested dir as the ref root

  • in the case of support_monorepo, there can be more than one ref root

The ref root is the central concept of the protoprimer project where every file is supposed to assume its own path relative to it.

This is the directory (base path) most of the paths are relative to.

See also:

  • "repo root"

  • "script dir"

"repo root"

The root directory of the repository with the client code.

See also:

  • "client code"

"script dir"

The dirname of the absolute path to the currently running script (without script basename).

This is the absolute path that allows keeping all other paths relative within the configuration. Script "knows" its relative position within the deployed filesystem, and it also knows its absolute path (from the runtime) - this combination allows accessing reliably any other resource.