Converted Python scripts into module (#46)

* Moving files into module `ompackagemanager`
* Updating calls to scripts

Author: AnHeuermann

.CI/OMPython/Dockerfile

@@ -1,3 +1,10 @@
 FROM openmodelica/openmodelica:v1.25.1-ompython
 
-RUN pip3 install --no-cache-dir semantic_version PyGithub atlassian-python-api && pip3 install --no-cache-dir --only-binary :all: pygit2 && apt-get clean && rm -rf /tmp/* /var/tmp/*
+RUN pip3 install --no-cache-dir \
+  argparse \
+  atlassian-python-api \
+  PyGithub \
+  semantic_version \
+  && pip3 install --no-cache-dir --only-binary :all: pygit2 \
+  && apt-get clean \
+  && rm -rf /tmp/* /var/tmp/*

.github/workflows/format.yml

@@ -27,9 +27,9 @@ jobs:
 
       - name: autopep8
         run: |
-          autopep8 --in-place --aggressive --aggressive *.py
+          autopep8 --in-place --aggressive --recursive ompackagemanager
           if ! git diff --exit-code; then
-            echo "❌ Code not formatted. Please run 'autopep8 --in-place --aggressive --aggressive *.py .' locally."
+            echo "❌ Code not formatted. Please run 'autopep8 --in-place --aggressive --recursive ompackagemanager' locally."
             exit 1
           else
             echo "✅ Code is properly formatted."

.github/workflows/test.yml

@@ -43,8 +43,8 @@ jobs:
           GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
         run: |
           test -f rawdata.json
-          python updateinfo.py
-          python genindex.py
+          python -m ompackagemanager updateinfo
+          python -m ompackagemanager genindex
 
       - name: Upload package index
         uses: actions/upload-artifact@v4

Jenkinsfile

@@ -29,8 +29,8 @@ pipeline {
       ln -s /var/lib/jenkins/gitcache/OMPackageManager cache
       '''
       sh 'test -f rawdata.json'
-      sh './updateinfo.py'
-      sh './genindex.py'
+      sh 'python3 -m ompackagemanager updateinfo'
+      sh 'python3 -m ompackagemanager genindex'
       stash name: 'files', includes: 'index.json, rawdata.json'
     }
   }
@@ -79,7 +79,7 @@ pipeline {
     steps {
       sh "du -csh /var/www/libraries.openmodelica.org/cache/* || true"
       sh "cp /var/www/libraries.openmodelica.org/index/v1/index.json ."
-      sh "./generate-cache.py --clean /var/www/libraries.openmodelica.org/cache"
+      sh "python3 -m ompackagemanager generate-cache --clean /var/www/libraries.openmodelica.org/cache"
       sh "du -csh /var/www/libraries.openmodelica.org/cache/*"
     }
   }

README.md

@@ -104,18 +104,27 @@ see the OpenModelica Library Testing
 ## 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`
+which is edited manually. Starting from this information, the `updateinfo`
 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
+up-to-date [rawdata.json](rawdata.json) file.
+
+```bash
+python -m ompackagemanager updateinfo
+```
+
+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
+`genindex` script is then run to generate the `index.json` database, which is
 queried by OMC clients to update the local package database.
 
+```bash
+python -m ompackagemanager genindex
+```
+
 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
@@ -148,8 +157,8 @@ Generate index file `index.json`.
 ```bash
 rm -rf cache/
 rm -f index.json
-python updateinfo.py
-python genindex.py
+python -m ompackagemanager updateinfo
+python -m ompackagemanager genindex
 ```
 
 To test the index file copy it into your OpenModelica libraries directory and
@@ -165,5 +174,5 @@ All Python code is formatted with
 [autopep8](https://pypi.org/project/autopep8/):
 
 ```bash
-autopep8 --in-place --aggressive --aggressive *.py
+autopep8 --in-place --aggressive --recursive ompackagemanager
 ```

generate-cache.py

@@ -0,0 +1,53 @@
+import argparse
+
+from ompackagemanager import updateinfo
+from ompackagemanager import genindex
+from ompackagemanager import generate_cache
+from ompackagemanager import check_missing
+from ompackagemanager import check_uses
+
+
+def main(argv=None):
+    """Run one of the Python scripts."""
+    parser = argparse.ArgumentParser(prog='OMPackageManager')
+    subparsers = parser.add_subparsers(dest='script', required=True)
+
+    # updateinfo command
+    parser1 = subparsers.add_parser(
+        'updateinfo', help='Generate up-to-date `rawdata.json`.')
+    parser1.set_defaults(func=updateinfo.main)
+
+    # genindex command
+    parser2 = subparsers.add_parser(
+        'genindex', help='Generate `index.json` from `rawdata.json`.')
+    parser2.set_defaults(func=genindex.main)
+
+    # generate-cache command
+    parser3 = subparsers.add_parser(
+        'generate-cache',
+        help='Cache indexed libraries in directory `destination`.')
+    parser3.add_argument('--clean', action='store_true')
+    parser3.add_argument('destination', help='Directory to cache packages in.')
+    parser3.set_defaults(func=generate_cache.main)
+
+    # check-missing command
+    parser4 = subparsers.add_parser(
+        'check-missing',
+        help='Print all GitHub repositories missing from modelica-3rdparty for packages from `repos.json`.')
+    parser4.set_defaults(func=check_missing.main)
+
+    # check-uses
+    parser5 = subparsers.add_parser('check-uses', help='Some help')
+    parser5.set_defaults(func=check_uses.main)
+
+    args = parser.parse_args(argv)
+    print(args.script)
+    match args.script:
+        case 'generate-cache':
+            args.func(args.destination, args.clean)
+        case _:
+            args.func()
+
+
+if __name__ == '__main__':
+    main()

ompackagemanager/__init__.py

@@ -1,12 +1,17 @@
-#!/usr/bin/env python3
-
 from github import Github
 import json
 import os
 import pygit2
 
 
 def main():
+    """Print all GitHub repositories missing from modelica-3rdparty.
+
+    Check if GitHub user `modelica-3rdparty` has a repository or fork for
+    each package of `repos.json`, that is hosted on GitHub.
+    Prints the missing repositories.
+    """
+
     gh_auth = os.environ["GITHUB_AUTH"]
     g = Github(gh_auth)
     data = json.load(open("repos.json"))
@@ -21,7 +26,3 @@ def main():
         if repo.fork and repo.parent.full_name in namesInRepos:
             continue
         print(repo.full_name)
-
-
-if __name__ == '__main__':
-    main()

ompackagemanager/__main__.py

@@ -1,14 +1,9 @@
-#!/usr/bin/env python3
-
-from github import Github
 import json
-import os
-import pygit2
-
 import semantic_version
 
 
 def main():
+    """Print used libraries for all packages in `index.json`."""
     data = json.load(open("index.json"))
     versionsWeHave = {}
     for lib in data["libs"].keys():
@@ -36,7 +31,3 @@ def main():
                     print("%s %s uses %s %s" % (lib, version, use, uses[use]))
                 else:
                     pass  # print("Have %s %s" % (use, uses[use]))
-
-
-if __name__ == '__main__':
-    main()