Below the functions used to call the applicaitons are defined. Functions are grouped into a few main areas, `create`, `register`, `verify`, `document`, `clean` these different areas allow you to perform actions in those domains.
create
(location
:str
='.'
)
create a new data registration area
register
(config_file
:Path
='.config/config.ini'
, force
:bool
=False
)
register any new data elements, run with --force to regeister existing data elements
verify
(config_file
:Path
='.config/config.ini'
, calc_hash
:bool
=False
)
verify the data registration environment to determine if there are data elements which need remediating.
i.e. there is data missing, a report missing, or a script missing.
this will also check the meta data of the files in the file system against the recorded metadata. If your
data isn't too big, run this with --calc_hash to activate hash verification.
document
(config_file
:Path
='./config/config.ini'
, force
:bool
=False
, sync
:bool
=True
)
Build documentation based on information in db and provided by analysts