[fearture request] Add repo description to the json file

[urfdvw]

By description, I mean the one line description field on the top right of the repo page

The current json is a list of objects like below

{
    "dependencies": [
        "adafruit_bus_device",
        "adafruit_register"
    ],
    "external_dependencies": [],
    "package": false,
    "path": "lib/adafruit_24lc32",
    "pypi_name": "adafruit-circuitpython-24lc32",
    "repo": "https://github.com/adafruit/adafruit_circuitpython_24lc32",
    "version": "1.2.3"
}

The purpose of this file is to be read by lib management tools.
In GUI lib management tools, such as the one in https://circuitpy.dev , it would be helpful if the repo description is added to this object.
This would help easier search by text through the libs, such as you can search "EEPROM" as a key word instead of remembering the chip model number, and thus increase lib visibility.

So that we can have

{
    "dependencies": [
        "adafruit_bus_device",
        "adafruit_register"
    ],
    "external_dependencies": [],
    "package": false,
    "path": "lib/adafruit_24lc32",
    "pypi_name": "adafruit-circuitpython-24lc32",
    "repo": "https://github.com/adafruit/adafruit_circuitpython_24lc32",
    "version": "1.2.3"
    "description": "CircuitPython Driver for Adafruit 24LC32 I2C EEPROM Breakout 32Kbit / 4 KB"
}

I am not sure how that can be achieved. By my shallow reseach, this field can be found in https://api.github.com/repos/adafruit/adafruit_circuitpython_24lc32
under field "description"

[ericzundel]

@makermelissa this might be of interest for future enhancements to code.circuitpython.org.

Hopefully, enriching adafruit-circuitpython-bundle-XXX.json with repo descriptions would have enough utility to justify the extra work for the CircuitPythonBundle maintainers.

Currently, my alternative ideas for solving this for an IDE app are

1. ~400 calls to github api from every IDE instance and then caching locally in the browser,
2. Automating a job to create a static data file for the IDE with the data pulled in and deploying the IDE frequently.
3. Spinning up a server to periodically cache the descriptions.

[Neradoc]

Currently the bundle zip contains the pyproject.toml files from the repositories, which have a "description" line.
It wouldn't be particularly difficult to have the build tool include that in the json file too.

https://github.com/adafruit/Adafruit_CircuitPython_24LC32/blob/main/pyproject.toml

[project]
name = "adafruit-circuitpython-24lc32"
description = "CircuitPython driver for Adafruit 24LC32 I2C EEPROM Breakout"

[ericzundel]

Currently the bundle zip contains the pyproject.toml files from the repositories, which have a "description" line. It wouldn't be particularly difficult to have the build tool include that in the json file too.

https://github.com/adafruit/Adafruit_CircuitPython_24LC32/blob/main/pyproject.toml

[project]
name = "adafruit-circuitpython-24lc32"
description = "CircuitPython driver for Adafruit 24LC32 I2C EEPROM Breakout"

Should we submit this feature request as an issue on https://github.com/adafruit/circuitpython-build-tools ? or just propose a patch?

[FoamyGuy]

I transferred this issue over to build tools repo.

@ericzundel a PR for this would be welcomed if you or anyone else interested is up for submitting one.