CLI Commands (`regolith.commands`)¶

Implementation of commands for command line.

regolith.commands.add_cmd(rc)[source]¶: Adds documents to a collection in a database.

regolith.commands.app(rc)[source]¶: Runs flask app

regolith.commands.build(rc)[source]¶: Builds all of the build targets

regolith.commands.build_db_check(rc)[source]¶: Checks which DBs a builder needs

regolith.commands.classlist(rc)[source]¶: Sets values for the class list.

regolith.commands.deploy(rc)[source]¶: Deploys all of the deployment targets.

regolith.commands.fs_to_mongo(rc: RunControl) → None[source]¶

Convert database collection from filesystem to mongo db.

Parameters:: rc (RunControl) – The RunControl. The mongo client will be created according to ‘mongodbpath’ in it. The databases will be loaded according to the ‘databases’ in it.

regolith.commands.grade(rc)[source]¶: Runs flask grading app

regolith.commands.helper(rc)[source]¶: Runs the helper targets

regolith.commands.helper_db_check(rc)[source]¶: Checks which DBs a builder needs

regolith.commands.ingest(rc)[source]¶: Ingests a foreign resource into a database.

regolith.commands.json_to_yaml(rc)[source]¶: Converts JSON to YAML

regolith.commands.mongo_to_fs(rc: RunControl) → None[source]¶

Convert database collection from filesystem to mongo db.

Parameters:: rc (RunControl) – The RunControl. The mongo client will be created according to ‘mongodbpath’ in it. The databases will be loaded according to the ‘databases’ in it.

regolith.commands.validate(rc)[source]¶: Validate the combined database against the schemas

regolith.commands.yaml_to_json(rc)[source]¶: Converts YAML to JSON