Coverage for src / check_datapackage / cli.py: 0%

1"""Functions for the exposed CLI.""" 

2 

3from pathlib import Path 

4from typing import Any 

5 

6from seedcase_soil import ( 

7 pretty_print, 

8 run_without_tracebacks, 

9 setup_cli, 

10) 

11 

12from check_datapackage.check import check 

13from check_datapackage.config import Config 

14from check_datapackage.read_json import read_json 

15 

16app = setup_cli( 

17 name="check-datapackage", 

18 help=( 

19 "check-datapackage checks if metadata is compliant with the Data Package" 

20 "standard" 

21 ), 

22 config_name=".cdp.toml", 

23) 

24 

25 

26@app.command(name="check") 

27def check_cmd( 

28 source: str = "datapackage.json", 

29 *, 

30 strict: bool = False, 

31) -> None: 

32 """Check a Data Package's metadata against the Data Package standard. 

33 

34 Outputs a human-readable explanation of any issues found. 

35 

36 Args: 

37 source: The local location of a `datapackage.json` file. 

38 strict: If True, check "SHOULD" properties in addition to "MUST" 

39 properties from the Data Package standard. 

40 """ 

41 properties: dict[str, Any] = read_json(Path(source)) 

42 config = Config(strict=strict) 

43 check(properties, config=config, error=True) 

44 pretty_print("[green]All checks passed! Your Data Package is valid.[/green]") 

45 

46 

47def main() -> None: 

48 """Create an entry point to run the cli without tracebacks.""" 

49 run_without_tracebacks(app)