Initial commit

samwillis · samwillis · commit 5714a152bb3b · 2022-06-16T17:25:11.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+/dist
+.DS_Store
+env*/
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,22 @@
+The MIT License (Expat)
+
+Copyright (c) 2021, whitequark <whitequark@whitequark.org>
+Copyright (c) 2022, Sam Willis <sam.willis@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,63 @@
+Node.js PyPI distribution
+=====================
+
+This repository contains the script used to repackage the [releases][nodejsdl] of [Node.js][nodejs] as [Python binary wheels][wheel]. This document is intended for maintainers; see the [package README][pkgreadme] for rationale and usage instructions.
+
+The repackaged artifacts are published as the [node-js PyPI package][pypi].
+
+[nodejs]: https://nodejs.org/
+[nodejsdl]:  https://nodejs.org/en/download/
+[wheel]: https://github.com/pypa/wheel
+[pkgreadme]: README.pypi.md
+[pypi]: https://pypi.org/project/node-js/
+
+This tool is based on the work of the creators of the [Zig language][ziglang], see [the original][basedon]. Thank you to them!
+
+[ziglang]: https://ziglang.org
+[basedon]: https://github.com/ziglang/zig-pypi
+
+Preparation
+-----------
+
+The script requires Python 3.5 or later.
+
+Install the dependencies:
+
+```shell
+pip install wheel twine libarchive-c
+```
+
+The `libarchive-c` Python library requires the native [libarchive][] library to be available.
+
+[libarchive]: https://libarchive.org/
+
+Building wheels
+---------------
+
+Run the repackaging script:
+
+```shell
+python make_wheels.py
+```
+
+This command will download the Node.js release archives for every supported platform and convert them to binary wheels, which are placed under `dist/`. The Node.js version and platforms are configured in the script source.
+
+The process of converting release archives to binary wheels is deterministic, and the output of the script should be bit-for-bit identical regardless of the environment and platform it runs under. To this end, it prints the SHA256 hashes of inputs and outputs; the hashes of the inputs will match the ones on the [Zig downloads page][nodejsdl], and the hashes of the outputs will match the ones on the [PyPI downloads page][pypidl].
+
+[pypidl]: https://pypi.org/project/node-js/#files
+
+Uploading wheels
+----------------
+
+Run the publishing utility:
+
+```shell
+twine dist/*
+```
+
+This command will upload the binary wheels built in the previous step to PyPI.
+
+License
+-------
+
+This script is distributed under the terms of the [MIT (Expat) license](LICENSE.txt).
diff --git a/README.pypi.md b/README.pypi.md
@@ -0,0 +1,31 @@
+Node.js PyPI distribution
+=====================
+
+[Node.js][] is an open-source, cross-platform, back-end JavaScript runtime environment that runs on the V8 engine and executes JavaScript code outside a web browser. 
+
+The [node-js][pypi] Python package redistributes Node.js so that it can be used as a dependency of Python projects.
+
+[zig]: https://nodejs.org/
+[pypi]: https://pypi.org/project/node-js/
+
+Usage
+-----
+
+To run the Zig toolchain from the command line, use:
+
+```shell
+python -m nodejs
+```
+
+To run Node.js from a Python program, use `sys.executable` to locate the Python binary to invoke. For example:
+
+```python
+import sys, subprocess
+
+subprocess.call([sys.executable, "-m", "nodejs"])
+```
+
+License
+-------
+
+The [Node.js license](https://raw.githubusercontent.com/nodejs/node/master/LICENSE).
diff --git a/make_wheels.py b/make_wheels.py
@@ -0,0 +1,199 @@
+import os
+import hashlib
+import urllib.request
+from email.message import EmailMessage
+from wheel.wheelfile import WheelFile, get_zipinfo_datetime
+from zipfile import ZipInfo, ZIP_DEFLATED
+import libarchive # from libarchive-c
+
+
+class ReproducibleWheelFile(WheelFile):
+    def writestr(self, zinfo, *args, **kwargs):
+        if not isinstance(zinfo, ZipInfo):
+            raise ValueError("ZipInfo required")
+        zinfo.date_time = (1980,1,1,0,0,0)
+        zinfo.create_system = 3
+        super().writestr(zinfo, *args, **kwargs)
+
+
+def make_message(headers, payload=None):
+    msg = EmailMessage()
+    for name, value in headers.items():
+        if isinstance(value, list):
+            for value_part in value:
+                msg[name] = value_part
+        else:
+            msg[name] = value
+    if payload:
+        msg.set_payload(payload)
+    return msg
+
+
+def write_wheel_file(filename, contents):
+    with ReproducibleWheelFile(filename, 'w') as wheel:
+        for member_info, member_source in contents.items():
+            if not isinstance(member_info, ZipInfo):
+                member_info = ZipInfo(member_info)
+                member_info.external_attr = 0o644 << 16
+            member_info.file_size = len(member_source)
+            member_info.compress_type = ZIP_DEFLATED
+            wheel.writestr(member_info, bytes(member_source))
+    return filename
+
+
+def write_wheel(out_dir, *, name, version, tag, metadata, description, contents, entry_points):
+    wheel_name = f'{name}-{version}-{tag}.whl'
+    dist_info  = f'{name}-{version}.dist-info'
+    return write_wheel_file(os.path.join(out_dir, wheel_name), {
+        **contents,
+        f'{dist_info}/entry_points.txt': ("""\
+[console_scripts]
+{entry_points}
+""".format(entry_points='\n'.join([f'{k} = {v}' for k, v in entry_points.items()] if entry_points else []))).encode('ascii'),
+        f'{dist_info}/METADATA': make_message({
+            'Metadata-Version': '2.1',
+            'Name': name,
+            'Version': version,
+            **metadata,
+        }, description),
+        f'{dist_info}/WHEEL': make_message({
+            'Wheel-Version': '1.0',
+            'Generator': 'nodejs-pypi make_wheels.py',
+            'Root-Is-Purelib': 'false',
+            'Tag': tag,
+        }),
+    })
+
+
+NODE_BINS = ('bin/node', 'node.exe')
+NODE_OTHER_BINS = {
+    'bin/npm': ('npm', True),
+    'npm.cmd': ('npm', False),
+    'bin/npx': ('npx', True),
+    'npx.cmd': ('npx', False),
+    'bin/corepack': ('corepack', True),     
+    'corepack.cmd': ('corepack', False),
+}
+
+
+def write_nodejs_wheel(out_dir, *, version, platform, archive):
+    contents = {}
+    entry_points = {}
+    contents['nodejs/__init__.py'] = f'__version__ = "{version}"\n'.encode('ascii')
+
+    with libarchive.memory_reader(archive) as archive:
+        for entry in archive:
+            entry_name = '/'.join(entry.name.split('/')[1:])
+            if entry.isdir or not entry_name:
+                continue
+
+            zip_info = ZipInfo(f'nodejs/{entry_name}')
+            zip_info.external_attr = (entry.mode & 0xFFFF) << 16
+            contents[zip_info] = b''.join(entry.get_blocks())
+
+            if entry_name in NODE_BINS:
+                entry_points['node'] = 'nodejs.node:main'
+                contents['nodejs/node.py'] = f'''\
+import os, sys, subprocess
+def run(args):
+    return subprocess.call([
+        os.path.join(os.path.dirname(__file__), "{entry_name}"),
+        *args
+    ])
+def main():
+    sys.exit(run(sys.argv[1:]))
+if __name__ == '__main__':
+    main()
+'''.encode('ascii')
+                contents['nodejs/__main__.py'] = f'''\
+from .node import main
+if __name__ == '__main__':
+    main()
+'''.encode('ascii')
+            elif entry_name in NODE_OTHER_BINS and NODE_OTHER_BINS[entry_name][1]:
+                entry_points[NODE_OTHER_BINS[entry_name][0]] = f'nodejs.{NODE_OTHER_BINS[entry_name][0]}:main'
+                script_name = '/'.join(os.path.normpath(os.path.join(os.path.dirname(entry.name), entry.linkpath)).split('/')[1:])
+                contents[f'nodejs/{NODE_OTHER_BINS[entry_name][0]}.py'] = f'''\
+import os, sys
+from .node import run as run_node
+def run(args):
+    return run_node([
+        os.path.join(os.path.dirname(__file__), "{script_name}"),
+        *args
+    ])
+def main():
+    sys.exit(run(sys.argv[1:]))
+if __name__ == '__main__':
+    main()
+'''.encode('ascii')
+            elif entry_name in NODE_OTHER_BINS:
+                entry_points[NODE_OTHER_BINS[entry_name][0]] = f'nodejs.{NODE_OTHER_BINS[entry_name][0]}:main'
+                contents[f'nodejs/{NODE_OTHER_BINS[entry_name][0]}.py'] = f'''\
+import os, sys, subprocess
+def run(args):
+    return subprocess.call([
+        os.path.join(os.path.dirname(__file__), "{entry_name}"),
+        *args
+    ])
+def main():
+    sys.exit(run(sys.argv[1:]))
+if __name__ == '__main__':
+    main()
+'''.encode('ascii')
+
+    with open('README.pypi.md') as f:
+        description = f.read()
+
+    return write_wheel(out_dir,
+        name='nodejs',
+        version=version,
+        tag=f'py3-none-{platform}',
+        metadata={
+            'Summary': 'Node.js is an open-source, cross-platform, back-end JavaScript runtime environment that runs on the V8 engine and executes JavaScript code outside a web browser.',
+            'Description-Content-Type': 'text/markdown',
+            'License': 'MIT',
+            'Classifier': [
+                'License :: OSI Approved :: MIT License',
+            ],
+            'Project-URL': [
+                'Homepage, https://nodejs.org',
+            ],
+            'Requires-Python': '~=3.5',
+        },
+        description=description,
+        contents=contents,
+        entry_points=entry_points,
+    )
+
+
+def main():
+    print('Making Node.js Wheels')
+    node_version = '16.15.1'
+    out_version = f'{node_version}a1'
+
+    for node_platform, python_platform in {
+        'win-x86':      'win32',
+        'win-x64':      'win_amd64',
+        'darwin-x64':   'macosx_10_9_x86_64',
+        'darwin-arm64': 'macosx_11_0_arm64',
+        'linux-x64':    'manylinux_2_12_x86_64.manylinux2010_x86_64',
+        'linux-armv7l': 'manylinux_2_17_armv7l.manylinux2014_armv7l',
+        'linux-arm64':  'manylinux_2_17_aarch64.manylinux2014_aarch64',
+    }.items():
+        print(f'- Making Wheel for {node_platform}')
+        node_url = f'https://nodejs.org/dist/v{node_version}/node-v{node_version}-{node_platform}.' + \
+                ('zip' if node_platform.startswith('win-') else 'tar.xz')
+        with urllib.request.urlopen(node_url) as request:
+            node_archive = request.read()
+            print(f'  {hashlib.sha256(node_archive).hexdigest()} {node_url}')
+
+        wheel_path = write_nodejs_wheel('dist/',
+            version=out_version,
+            platform=python_platform,
+            archive=node_archive)
+        with open(wheel_path, 'rb') as wheel:
+            print(f'  {hashlib.sha256(wheel.read()).hexdigest()} {wheel_path}')
+
+
+if __name__ == '__main__':
+    main()
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,3 @@
+wheel
+twine
+libarchive-c
