Skip to content

Add catalog cache creator #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 2, 2025
Merged

Conversation

chennes
Copy link
Member

@chennes chennes commented May 19, 2025

The AddonCatalogCacheCreator.py script is intended to be run server-side to generate a cache of addon metadata: the contents of any package.xml, requirements.txt, and metadata.txt files are included. If the package.xml file is present, the cache will also include the icon that represents the addon (either the icon set for the top-level package element, or the first icon specified for a content element). The cache represents all known branches/tags/versions of an Addon, as specified in the https://github.com/FreeCAD/FreeCAD-addons/blob/master/AddonCatalog.json file.

@chennes chennes force-pushed the activateAddonCatalog branch from e9d947f to eb7fe15 Compare May 19, 2025 03:13
@chennes chennes marked this pull request as draft May 31, 2025 21:12
@chennes
Copy link
Member Author

chennes commented May 31, 2025

I think the cache should be zipped up server-side, so I'm going to implement that before merging.

chennes added 2 commits June 1, 2025 15:14
The AddonCatalogCacheCreator.py script is intended to be run server-side
by a cron-like process, regularly generating a downloadable cache of all
addon metadata. The Addon Manager will then fetch this file, which in
conjunction with the Addon Catalog hosted at
https://github.com/FreeCAD/FreeCAD-Addons/AddonCatalog.json
will be enough information to display the list of non-macro addons,
including their icons. As of this writing the cache file is approximately
4MB uncompressed.
@chennes chennes force-pushed the activateAddonCatalog branch from eb7fe15 to 56f7206 Compare June 1, 2025 20:14
@chennes chennes marked this pull request as ready for review June 1, 2025 20:15
@chennes chennes merged commit 8614198 into FreeCAD:main Jun 2, 2025
11 checks passed
@chennes chennes deleted the activateAddonCatalog branch June 2, 2025 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant