Merge branch 'master' of https://github.com/OpenModelica/OMPackageManager

Author: AHaumer

README.md

@@ -5,45 +5,41 @@ available open-source libraries, which are hosted on GIT repositories. The ratio
 [User's Guide](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/packagemanager.html). The package manager
 is available both via API calls in the interactive environment, and via the OMEdit GUI using the _File | Manage Libraries_ menu.
 
-## Configuration of the Package Manager server
+## Adding a new library
 
-The database of managed libraries is kept in the [repos.json](repos.json) file, which is edited manually. If you want to add
-your own open-source library to the OpenModelica package manager, please fork the OMPackageManager repository, add you library
-to the [repos.json](repos.json) database and open a pull request, or request us to do it for you by opening a request on the
-[OpenModelica issue tracker](https://github.com/OpenModelica/OpenModelica/issues/new/choose).
-
-Starting from this information, the `updateinfo.py` script queries the repositories where the libraries are stored and
-generates an up-to-date [rawdata.json](rawdata.json) file. This script is run by the
-[Update Package Index job](https://test.openmodelica.org/jenkins/job/Update%20Package%20Index/) on OSMC's Jenkins
-server four times a day to keep it up to date with library developments.
-Note that the query includes advanced Modelica-specific features, e.g. determining dependencies
-via the `uses` annotations, and determining backwards compatibility among versions via the `conversion` annotations.
-The `genindex.py` script is then run to generate the `index.json` database, which is queried by OMC clients to
-update the local package database.
-
-The package manager preferably refers to official library releases, which are fetched automatically from the GitHub
-server without the need of naming them explicitly in the [repos.json](repos.json)
-file; whenever a new version of a library is released, the [repos.json](repos.json)
-is automatically updated to make it available. However, it is also possible to manage versions of the library that are located on specific named
-branches, e.g. master or maintenance branches. This is useful if you want to track development versions or you want to get the latest fixes
-before the official release.
+If you want to add your own open-source library to the OpenModelica package manager, please fork the OMPackageManager repository,
+add your library to the [repos.json](repos.json) database, and open a pull request.
 
 For each library, the [repos.json](repos.json) database contains several pieces of information:
-- the name of the library(es) (`names` field); it is possible to collect a set of libraries that are found in the same GIT repository
-  e.g. Modelica, ModelicaReference, ModelicaServices, Complex, ModelicaTest
-- the location of the GIT repository on GitHub (`github` field), or the git URL in case other servers are used (`git` field)
+- The name of the library(es) (`names` field); it is possible to collect a set of libraries that are found in the same GIT repository
+  e.g. Modelica, ModelicaReference, ModelicaServices, Complex, ModelicaTest.
+- The location of the GIT repository on GitHub (`github` field), or the git URL in case other servers are used (`git` field).
 - Optional locations within the git repository (`search-extra-paths` field) to search for libraries. This can be specified if the libraries are not located at the root of repository.
-- optional branches to be managed besides the official releases (`branches` field)
-- optional tags to be ignored, if one wants to avoid them to be considered by the package manager (`ignore-tags` field)
-- the level of support in OpenModelica of the various versions of the library.
+- Optional branches to be managed besides the official releases (`branches` field).
+- Optional tags to be ignored, if one wants to avoid them to be considered by the package manager (`ignore-tags` field).
+- The level of support in OpenModelica of the various versions of the library (`support` field), see below.
+
+As an example, if you develop your library `MyLibrary` at "https://github.com/myGithubName/MyLibrary.git",
+you can add a json object like the following to [repos.json](repos.json)
+```json
+  "MyLibrary": {
+    "names": ["MyLibrary"],
+    "github": "myGithubName/MyLibrary",
+    "support": [
+      ["*", "noSupport"]
+    ]
+  },
+
+```
 
 ## Library support levels in OpenModelica
+
 There are five levels of support:
-- `fullSupport`: The library is fully supported by OpenModelica, with over 95% runnable models in the library simulating correctly
-- `support`: The library is partially supported by OpenModelica; most models and features work correctly, but some still don't
-- `experimental`: The library is currently being tested with OpenModelica, but there is no guarantee of success when using it
-- `noSupport`: The library is actively developed or maintained, but is not supported by OpenModelica
-- `obsolete`: The library is no longer developed or maintained, or it has been completely superseded by more recent versions
+- `fullSupport`: The library is fully supported by OpenModelica, with over 95% runnable models in the library simulating correctly.
+- `support`: The library is partially supported by OpenModelica; most models and features work correctly, but some still don't.
+- `experimental`: The library is currently being tested with OpenModelica, but there is no guarantee of success when using it.
+- `noSupport`: The library is actively developed or maintained, but is not supported by OpenModelica.
+- `obsolete`: The library is no longer developed or maintained, or it has been completely superseded by more recent versions.
 
 Note that a library may not be fully supported because of OpenModelica limitations or bugs, but also because the library
 is not fully compliant to the Modelica Language standard. In both cases, we are open to cooperation with open-source
@@ -61,7 +57,7 @@ The support field may contain multiple selection criteria that are applied seque
       ["*", "obsolete"]
     ]
 ```
-means that all pre-release version are not supported, all _remaining_ versions with version number greater or equal to
+means that all pre-release versions are not supported, all _remaining_ versions with version number greater or equal to
 7.0.0 are fully supported, all _remaining_ versions with version number greater or equal to 5.1.0 are partially supported,
 and all _remaining_ versions are considered obsolete.
 
@@ -70,3 +66,22 @@ When the first string starts with `>=`, all versions with equal or higher releas
 version. In all other cases the first string must match verbatim the version number.
 
 Some libraries in the package manager are regularly tested on the OSMC servers, see the OpenModelica Library Testing [README.md](https://github.com/OpenModelica/OpenModelicaLibraryTesting/blob/master/README.md).
+
+## Configuration of the Package Manager server
+
+The database of managed libraries is kept in the [repos.json](repos.json) file, which is edited manually.
+Starting from this information, the `updateinfo.py` script queries the repositories where the libraries are stored and
+generates an up-to-date [rawdata.json](rawdata.json) file. This script is run by the
+[Update Package Index job](https://test.openmodelica.org/jenkins/job/Update%20Package%20Index/) on OSMC's Jenkins
+server four times a day to keep it up to date with library developments.
+Note that the query includes advanced Modelica-specific features, e.g. determining dependencies
+via the `uses` annotations, and determining backwards compatibility among versions via the `conversion` annotations.
+The `genindex.py` script is then run to generate the `index.json` database, which is queried by OMC clients to
+update the local package database.
+
+The package manager preferably refers to official library releases, which are fetched automatically from the GitHub
+server without the need of naming them explicitly in the [repos.json](repos.json)
+file; whenever a new version of a library is released, the [repos.json](repos.json)
+is automatically updated to make it available. However, it is also possible to manage versions of the library that are located on specific named
+branches, e.g. master or maintenance branches. This is useful if you want to track development versions or you want to get the latest fixes
+before the official release.

common.py

@@ -12,7 +12,6 @@ def VersionNumber(s):
   except:
     return semantic_version.Version(major=0, minor=0, patch=0, prerelease=(s,))
 
-
 def findMatchingLevel(s, levels):
   try:
     vn = VersionNumber(s)

generate-cache.py

@@ -21,7 +21,6 @@ def filename(url):
         return os.path.join(args.destination, url.removeprefix("https://"))
     raise Exception(url)
 
-
 urls = set()
 for index in [json.loads(requests.get("https://raw.githubusercontent.com/OpenModelica/OpenModelica/%s/libraries/%s" % branch_file).content) for branch_file in itertools.product(["master", "maintenance/v1.20"],["index.json","install-index.json"])] + [json.load(open("index.json"))]:
     for lib in index["libs"].values():

genindex.py

@@ -124,8 +124,10 @@ def main():
           entry['zipfile'] = r["zip"]
         elif "github" in repos[firstKey]:
           entry['zipfile'] = "https://github.com/%s/archive/%s.zip" % (repos[firstKey]["github"], r['sha'])
-        else:
+        elif "zipfile" in repos[firstKey]:
           entry['zipfile'] = repos[firstKey]["zipfile"].format(r['sha'])
+        else:
+          raise Exception("Entry does not list an entry \"zip\" (manually added zip-file), \"github\" (project name), or \"zipfile\" URL from where to download the git hash (gitlab/etc):\n"+str(r))
         if 'provides' in lib:
           entry['provides'] = lib['provides']
         if 'uses' in lib:
@@ -139,7 +141,7 @@ def main():
         libdict[lib['version']] = entry
         # print(entry)
     # for lib in data["libs"].keys():
-  
+
   for libName in indexdata["libs"].keys():
     versions = indexdata["libs"][libName]["versions"]
     for version in versions.keys():