Skip to content

Using repogen.py

vgmoose edited this page Apr 11, 2018 · 1 revision

Purpose

A python script is provided in the web folder called repogen.py. It takes the contents of a relative packages folder and creates a repo.json file, as well as zipping them into the zips folder.

Once the script is executed, the entire root of the web folder can be uploaded to a static server.

Usage

The script will take care of generating a default info.json (containing only the package name) and a default manifest.install file (setting all files within the package to the U: state). It is highly recommended to put your own info.json file within the package's folder containing at least a version, title, and short description. The contents of the info.json file should match exactly the Package layout.

Once the files are zipped, the repo.json file is created and ready to be hosted (along with the zips folder) in its entirety to the static http(s) server, or to a CDN.

The repogen.py script can be executed directly on the server if desired, or a third-party tool could maintain the package zips + repo list dynamically as an alternative to doing it all statically within repogen.py. If this is done, please considering contributing the code back to this project!

Clone this wiki locally