api.py 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. """This script automates the generation of the QMK API data.
  2. """
  3. from pathlib import Path
  4. import shutil
  5. import json
  6. from milc import cli
  7. from qmk.datetime import current_datetime
  8. from qmk.info import info_json
  9. from qmk.json_encoders import InfoJSONEncoder
  10. from qmk.json_schema import json_load
  11. from qmk.keyboard import find_readme, list_keyboards
  12. DATA_PATH = Path('data')
  13. TEMPLATE_PATH = DATA_PATH / 'templates/api/'
  14. BUILD_API_PATH = Path('.build/api_data/')
  15. def _filtered_keyboard_list():
  16. """Perform basic filtering of list_keyboards
  17. """
  18. keyboard_list = list_keyboards()
  19. if cli.args.filter:
  20. kb_list = []
  21. for keyboard_name in keyboard_list:
  22. if any(i in keyboard_name for i in cli.args.filter):
  23. kb_list.append(keyboard_name)
  24. keyboard_list = kb_list
  25. return keyboard_list
  26. @cli.argument('-n', '--dry-run', arg_only=True, action='store_true', help="Don't write the data to disk.")
  27. @cli.argument('-f', '--filter', arg_only=True, action='append', default=[], help="Filter the list of keyboards based on partial name matches the supplied value. May be passed multiple times.")
  28. @cli.subcommand('Generate QMK API data', hidden=False if cli.config.user.developer else True)
  29. def generate_api(cli):
  30. """Generates the QMK API data.
  31. """
  32. v1_dir = BUILD_API_PATH / 'v1'
  33. keyboard_all_file = v1_dir / 'keyboards.json' # A massive JSON containing everything
  34. keyboard_list_file = v1_dir / 'keyboard_list.json' # A simple list of keyboard targets
  35. keyboard_aliases_file = v1_dir / 'keyboard_aliases.json' # A list of historical keyboard names and their new name
  36. keyboard_metadata_file = v1_dir / 'keyboard_metadata.json' # All the data configurator/via needs for initialization
  37. usb_file = v1_dir / 'usb.json' # A mapping of USB VID/PID -> keyboard target
  38. if BUILD_API_PATH.exists():
  39. shutil.rmtree(BUILD_API_PATH)
  40. shutil.copytree(TEMPLATE_PATH, BUILD_API_PATH)
  41. shutil.copytree(DATA_PATH, v1_dir)
  42. # Filter down when required
  43. keyboard_list = _filtered_keyboard_list()
  44. kb_all = {}
  45. usb_list = {}
  46. # Generate and write keyboard specific JSON files
  47. for keyboard_name in keyboard_list:
  48. kb_all[keyboard_name] = info_json(keyboard_name)
  49. keyboard_dir = v1_dir / 'keyboards' / keyboard_name
  50. keyboard_info = keyboard_dir / 'info.json'
  51. keyboard_readme = keyboard_dir / 'readme.md'
  52. keyboard_readme_src = find_readme(keyboard_name)
  53. keyboard_dir.mkdir(parents=True, exist_ok=True)
  54. keyboard_json = json.dumps({'last_updated': current_datetime(), 'keyboards': {keyboard_name: kb_all[keyboard_name]}})
  55. if not cli.args.dry_run:
  56. keyboard_info.write_text(keyboard_json)
  57. cli.log.debug('Wrote file %s', keyboard_info)
  58. if keyboard_readme_src:
  59. shutil.copyfile(keyboard_readme_src, keyboard_readme)
  60. cli.log.debug('Copied %s -> %s', keyboard_readme_src, keyboard_readme)
  61. if 'usb' in kb_all[keyboard_name]:
  62. usb = kb_all[keyboard_name]['usb']
  63. if 'vid' in usb and usb['vid'] not in usb_list:
  64. usb_list[usb['vid']] = {}
  65. if 'pid' in usb and usb['pid'] not in usb_list[usb['vid']]:
  66. usb_list[usb['vid']][usb['pid']] = {}
  67. if 'vid' in usb and 'pid' in usb:
  68. usb_list[usb['vid']][usb['pid']][keyboard_name] = usb
  69. # Generate data for the global files
  70. keyboard_list = sorted(kb_all)
  71. keyboard_aliases = json_load(Path('data/mappings/keyboard_aliases.json'))
  72. keyboard_metadata = {
  73. 'last_updated': current_datetime(),
  74. 'keyboards': keyboard_list,
  75. 'keyboard_aliases': keyboard_aliases,
  76. 'usb': usb_list,
  77. }
  78. # Write the global JSON files
  79. keyboard_all_json = json.dumps({'last_updated': current_datetime(), 'keyboards': kb_all}, cls=InfoJSONEncoder)
  80. usb_json = json.dumps({'last_updated': current_datetime(), 'usb': usb_list}, cls=InfoJSONEncoder)
  81. keyboard_list_json = json.dumps({'last_updated': current_datetime(), 'keyboards': keyboard_list}, cls=InfoJSONEncoder)
  82. keyboard_aliases_json = json.dumps({'last_updated': current_datetime(), 'keyboard_aliases': keyboard_aliases}, cls=InfoJSONEncoder)
  83. keyboard_metadata_json = json.dumps(keyboard_metadata, cls=InfoJSONEncoder)
  84. if not cli.args.dry_run:
  85. keyboard_all_file.write_text(keyboard_all_json)
  86. usb_file.write_text(usb_json)
  87. keyboard_list_file.write_text(keyboard_list_json)
  88. keyboard_aliases_file.write_text(keyboard_aliases_json)
  89. keyboard_metadata_file.write_text(keyboard_metadata_json)