Merge pull request #57 from Distributive-Network/Xmader/feat/post-install-npm

Xmader · web-flow · commit e8147b11b790 · 2023-07-05T13:04:15.000-04:00
Run `npm i` at  `pip install pythonmonkey` time
diff --git a/.github/workflows/test-and-publish.yaml b/.github/workflows/test-and-publish.yaml
@@ -117,7 +117,7 @@ jobs:
           echo "Installing python deps"
           poetry self add "poetry-dynamic-versioning[plugin]"
           poetry env use python3 # use the correct Python version we've set up
-          poetry install --no-root
+          poetry install --no-root --only=dev
           echo "Installed Dependencies"
       - name: Use cached spidermonkey build
         uses: actions/cache@v3
@@ -126,6 +126,13 @@ jobs:
             ./_spidermonkey_install/*
           key: spidermonkey-${{ runner.os }}-${{ runner.arch }}
           fail-on-cache-miss: true # SpiderMonkey is expected to be cached in its dedicated job
+      - name: Build pminit
+        run: |
+          cd python/pminit
+          poetry build --format=sdist
+          cd -
+          mkdir -p ./dist/
+          mv -v python/pminit/dist/* ./dist/
       - name: Build wheel
         run: |
           echo $(poetry run python --version)
@@ -138,7 +145,7 @@ jobs:
           path: ./dist/
       - name: Run Python tests (pytest)
         run: |
-          poetry run python -m pip install --force-reinstall ./dist/*.whl
+          poetry run python -m pip install --force-reinstall ./dist/*
           poetry run python -m pytest tests/python
   sdist:
     runs-on: ubuntu-20.04
@@ -205,16 +212,26 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: wheel-${{ github.run_id }}-${{ github.sha }}
-          path: ./pythonmonkey/ # write to the repository project path 
+          path: ./dist/
+      - name: Move wheels to the correct repository project paths
+        run: |
+          mkdir -p ./pythonmonkey/ ./pminit/
+          mv ./dist/pythonmonkey-* ./pythonmonkey/
+          mv ./dist/pminit-* ./pminit/
       - name: Generate index page for the project
         run: |
-          cd ./pythonmonkey/
-          html="<html><head><title>PythonMonkey Nightly Builds</title></head><body>"
-          for file in ./*; do # generate <a> tags for each file
-            html+="<a href=\"$file\">$file</a><br/>"
-          done
-          html+="</body></html>"
-          echo "$html" > ./index.html
+          generate_index () {
+            cd $1
+            html="<html><head><title>PythonMonkey Nightly Builds</title></head><body>"
+            for file in ./*; do # generate <a> tags for each file
+              html+="<a href=\"$file\">$file</a><br/>"
+            done
+            html+="</body></html>"
+            echo "$html" > ./index.html
+            cd -
+          }
+          generate_index ./pythonmonkey/
+          generate_index ./pminit/
       - name: Generate repository root page
         run: |
           html="<html><head><title>PythonMonkey Nightly Builds</title></head><body>"
@@ -223,6 +240,7 @@ jobs:
           html+="<pre>pip install -i https://nightly.pythonmonkey.io/ --pre pythonmonkey</pre>"
           html+="<h3>Browse files:</h3>"
           html+="<a href="pythonmonkey/">pythonmonkey</a>"
+          html+="<a href="pminit/">pminit</a>"
           html+="</body></html>"
           echo "$html" > ./index.html
       - uses: actions/upload-pages-artifact@v1
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,6 @@
 build/
 .vscode/
 pyvenv.cfg
-python/pythonmonkey/version.py
 python/pythonmonkey/node_modules
 bin/
 lib/*
@@ -15,8 +14,6 @@ _spidermonkey_install
 __pycache__/*
 dist
 *.so
-_spidermonkey_install/*
-*~
 *.dylib
 *.dll
 *.pyd
diff --git a/README.md b/README.md
@@ -57,11 +57,12 @@ this package to execute our complex `dcp-client` library, which is written in JS
     - [Poetry](https://python-poetry.org/docs/#installation)
     - [poetry-dynamic-versioning](https://github.com/mtkennerly/poetry-dynamic-versioning)
 
-2. Run `poetry install`. This command automatically compiles the project and installs the project as well as all Python dependencies to the poetry virtualenv.
+2. Run `poetry run pip install --verbose python/pminit ./`. This command automatically compiles the project and installs the project as well as dependencies into the poetry virtualenv.
 
 ## Running tests
 1. Compile the project 
-2. From the root directory, run `poetry run pytest ./tests/python`
+2. Install development dependencies: `poetry install --no-root --only=dev`
+3. From the root directory, run `poetry run pytest ./tests/python`
 
 ## Using the library
 
diff --git a/build_script.sh b/build_script.sh
@@ -23,8 +23,3 @@ else
   cmake .. 
 fi
 cmake --build . -j$CPUS --config Release
-
-cd ../python/pythonmonkey
-# npm is used to load JS components, see package.json
-cd "${topDir}/python/pythonmonkey/"
-npm i
diff --git a/pyproject.toml b/pyproject.toml
@@ -11,14 +11,11 @@ include = [
   # Linux and macOS
   "python/pythonmonkey/pythonmonkey.so",
   "python/pythonmonkey/libmozjs*",
-  "python/pythonmonkey/builtin_modules/**/*",
 
   # Windows
   "python/pythonmonkey/pythonmonkey.pyd",
   "python/pythonmonkey/mozjs-*.dll",
 
-  "python/pythonmonkey/node_modules/**/*",
-
   # include all files for source distribution
   { path = "src", format = "sdist" },
   { path = "include", format = "sdist" },
@@ -34,6 +31,7 @@ include = [
 
 [tool.poetry.dependencies]
 python = "^3.8"
+pminit = { version = "*", allow-prereleases = true }
 
 
 [tool.poetry-dynamic-versioning]
diff --git a/python/pminit/.gitignore b/python/pminit/.gitignore
@@ -0,0 +1 @@
+node_modules
diff --git a/python/pminit/pminit/__init__.py b/python/pminit/pminit/__init__.py
@@ -0,0 +1,2 @@
+# Placeholder
+# A __init__.py file is required by pip 
diff --git a/python/pminit/post-install-hook.py b/python/pminit/post-install-hook.py
@@ -0,0 +1,20 @@
+import subprocess
+import sys
+
+def execute(cmd: str):
+    popen = subprocess.Popen(cmd, stdout = subprocess.PIPE, stderr = subprocess.STDOUT,
+        shell = True, text = True )
+    for stdout_line in iter(popen.stdout.readline, ""):
+        sys.stdout.write(stdout_line)
+        sys.stdout.flush()
+
+    popen.stdout.close()
+    return_code = popen.wait()
+    if return_code:
+        raise subprocess.CalledProcessError(return_code, cmd)
+
+def main():
+    execute("cd pythonmonkey && npm i --no-package-lock") # do not update package-lock.json
+
+if __name__ == "__main__":
+    main()
diff --git a/python/pminit/pyproject.toml b/python/pminit/pyproject.toml
@@ -0,0 +1,35 @@
+[tool.poetry]
+name = "pminit"
+version = "0"
+description = "Post-install hook for PythonMonkey"
+authors = [
+  "Tom Tang <xmader@distributive.network>",
+  "Caleb Aikens <caleb@distributive.network>",
+  "Wes Garland <wes@distributive.network>",
+  "Hamada Gasmallah <hamada@distributive.network>"
+]
+include = [
+  # Install extra files into the pythonmonkey package
+  "pythonmonkey/package*.json",
+  { path = "pythonmonkey/node_modules/**/*", format = "wheel" },
+  # pip builds (and actually installs from) the wheel when installing from sdist
+  # we don't want node_modules inside the sdist package
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+
+[tool.poetry-dynamic-versioning]
+enable = true
+vcs = "git"
+style = "pep440"
+bump = true
+
+[tool.poetry.build]
+script = "post-install-hook.py"
+generate-setup-file = false 
+
+[build-system]
+requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
+build-backend = "poetry_dynamic_versioning.backend"
+
diff --git a/python/pminit/pythonmonkey/package-lock.json b/python/pminit/pythonmonkey/package-lock.json
diff --git a/python/pminit/pythonmonkey/package.json b/python/pminit/pythonmonkey/package.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Placeholder`
	`2`	`+# A __init__.py file is required by pip`