autopep8 formatting (#45)

* Formatted README.md

  - Line-break after col 80

* Formatted Python files with autopep8

* Adding workflow for autopep8

Author: AnHeuermann

.github/workflows/format.yml

@@ -0,0 +1,36 @@
+name: autopep8 formatting
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  check-format:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+          cache: 'pip'
+
+      - name: Install Dependencies
+        run:
+          pip install autopep8
+
+      - name: autopep8
+        run: |
+          autopep8 --in-place --aggressive --aggressive *.py
+          if ! git diff --exit-code; then
+            echo "❌ Code not formatted. Please run 'autopep8 --in-place --aggressive --aggressive *.py .' locally."
+            exit 1
+          else
+            echo "✅ Code is properly formatted."
+          fi

README.md

@@ -1,26 +1,41 @@
 # OpenModelica Package Manager
 
-OpenModelica comes with an integrated Modelica package manager to handle the installation and updates of publicly
-available open-source libraries, which are hosted on GIT repositories. The rationale and use of the package mananager is discussed in the
-[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.
+OpenModelica comes with an integrated Modelica package manager to handle the
+installation and updates of publicly available open-source libraries, which are
+hosted on GIT repositories. The rationale and use of the package mananager is
+discussed in the
+[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.
 
 ## Adding a new library
 
-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.
+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).
+- 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
+  (`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)
 
-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).
-- 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 (`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"],
@@ -35,20 +50,30 @@ you can add a json object like the following to [repos.json](repos.json)
 ## 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.
-
-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
-Modelica library developers, to fix the OpenModelica issues on one hand, and to help them fix it so it is fully
-compliant to the standard on the other hand. Please open an issue on the
-[OpenModelica issue tracker](https://github.com/OpenModelica/OpenModelica/issues) if you want to start the process on your
-open-source Modelica library.
-
-The support field may contain multiple selection criteria that are applied sequentially. For example:
+
+- `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 Modelica library developers, to fix the OpenModelica issues on one
+hand, and to help them fix it so it is fully compliant to the standard on the
+other hand. Please open an issue on the [OpenModelica issue
+tracker](https://github.com/OpenModelica/OpenModelica/issues) if you want to
+start the process on your open-source Modelica library.
+
+The support field may contain multiple selection criteria that are applied
+sequentially. For example:
+
 ```json
 "support": [
       ["prerelease", "noSupport"],
@@ -57,63 +82,88 @@ The support field may contain multiple selection criteria that are applied seque
       ["*", "obsolete"]
     ]
 ```
-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.
 
-When the first string starts with `>=`, all versions with equal or higher release number according to semver get the attribute of the second string. The string
-`prerelease` identifies all pre-release version, that have a semver metadata starting with `-`. It is also possible to start the first string with `+`, as in `+default.modelica.association` that matches `v3.2.1+default.modelica.association` and `v3.2.2+default.modelica.association`. The wildcard `*` matches any
-version. In all other cases the first string must match verbatim the version number.
+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.
 
-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).
+When the first string starts with `>=`, all versions with equal or higher
+release number according to semver get the attribute of the second string. The
+string `prerelease` identifies all pre-release version, that have a semver
+metadata starting with `-`. It is also possible to start the first string with
+`+`, as in `+default.modelica.association` that matches
+`v3.2.1+default.modelica.association` and `v3.2.2+default.modelica.association`.
+The wildcard `*` matches any 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.
+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.
 
 ## Generate Package Index
 
 Install dependencies:
 
-  - Python 3
-  - OpenModelica
+- Python 3
+- OpenModelica
 
 ```bash
 pip install -r requirements.txt
 ```
 
-Create a public_repo personal access token for GitHub and define an environment variable `GITHUB_AUTH`:
+Create a public_repo personal access token for GitHub and define an environment
+variable `GITHUB_AUTH`:
 
 ```bash
 export GITHUB_AUTH=<your PAT>
 ```
 
 Generate index file `index.json`.
+
 ```bash
 rm -rf cache/
 rm -f index.json
 python updateinfo.py
 python genindex.py
 ```
 
-To test the index file copy it into your OpenModelica libraries directory
-and test it via OMEdit / scripting API:
+To test the index file copy it into your OpenModelica libraries directory and
+test it via OMEdit / scripting API:
 
 ```bash
 cp index.json ~/.openmodelica/libraries/index.json
-````
+```
+
+## Development
+
+All Python code is formatted with
+[autopep8](https://pypi.org/project/autopep8/):
+
+```bash
+autopep8 --in-place --aggressive --aggressive *.py
+```

check-missing.py

@@ -5,21 +5,23 @@
 import os
 import pygit2
 
+
 def main():
-  gh_auth = os.environ["GITHUB_AUTH"]
-  g = Github(gh_auth)
-  data = json.load(open("repos.json"))
-  namesInRepos = set()
-  for entry in data.values():
-    if "github" in entry:
-      namesInRepos.add(entry["github"])
+    gh_auth = os.environ["GITHUB_AUTH"]
+    g = Github(gh_auth)
+    data = json.load(open("repos.json"))
+    namesInRepos = set()
+    for entry in data.values():
+        if "github" in entry:
+            namesInRepos.add(entry["github"])
+
+    for repo in list(g.get_user("modelica-3rdparty").get_repos()):
+        if repo.full_name in namesInRepos:
+            continue
+        if repo.fork and repo.parent.full_name in namesInRepos:
+            continue
+        print(repo.full_name)
 
-  for repo in list(g.get_user("modelica-3rdparty").get_repos()):
-    if repo.full_name in namesInRepos:
-      continue
-    if repo.fork and repo.parent.full_name in namesInRepos:
-      continue
-    print(repo.full_name)
 
 if __name__ == '__main__':
-  main()
+    main()

check-uses.py

@@ -7,29 +7,36 @@
 
 import semantic_version
 
+
 def main():
-  data = json.load(open("index.json"))
-  versionsWeHave = {}
-  for lib in data["libs"].keys():
-    versionsWeHave[lib] = set()
-    versions = data["libs"][lib]["versions"]
-    for version in versions.keys():
-      versionsWeHave[lib].add(semantic_version.Version.coerce(version).truncate())
-      for provide in versions[version].get("provides",[]):
-        versionsWeHave[lib].add(semantic_version.Version.coerce(provide).truncate())
-  print(versionsWeHave)
-  for lib in data["libs"].keys():
-    versions = data["libs"][lib]["versions"]
-    for version in versions.keys():
-      uses = versions[version].get("uses",{})
-      for use in uses.keys():
-        if use not in versionsWeHave:
-          print("%s %s uses unknown library %s %s" % (lib, version, use, uses[use]))
-          continue
-        if semantic_version.Version.coerce(uses[use]).truncate() not in versionsWeHave[use]:
-          print("%s %s uses %s %s" % (lib, version, use, uses[use]))
-        else:
-          pass # print("Have %s %s" % (use, uses[use]))
+    data = json.load(open("index.json"))
+    versionsWeHave = {}
+    for lib in data["libs"].keys():
+        versionsWeHave[lib] = set()
+        versions = data["libs"][lib]["versions"]
+        for version in versions.keys():
+            versionsWeHave[lib].add(
+                semantic_version.Version.coerce(version).truncate())
+            for provide in versions[version].get("provides", []):
+                versionsWeHave[lib].add(
+                    semantic_version.Version.coerce(provide).truncate())
+    print(versionsWeHave)
+    for lib in data["libs"].keys():
+        versions = data["libs"][lib]["versions"]
+        for version in versions.keys():
+            uses = versions[version].get("uses", {})
+            for use in uses.keys():
+                if use not in versionsWeHave:
+                    print(
+                        "%s %s uses unknown library %s %s" %
+                        (lib, version, use, uses[use]))
+                    continue
+                if semantic_version.Version.coerce(
+                        uses[use]).truncate() not in versionsWeHave[use]:
+                    print("%s %s uses %s %s" % (lib, version, use, uses[use]))
+                else:
+                    pass  # print("Have %s %s" % (use, uses[use]))
+
 
 if __name__ == '__main__':
-  main()
+    main()