Seperate the command line commands into separate optional package

Author: samwillis

.gitignore

@@ -1,4 +1,7 @@
 /dist
+nodejs-cmd/build
+nodejs-cmd/dist
+nodejs-cmd/*.egg-info
 .DS_Store
 env*/
 __pycache__/

README.md

@@ -23,6 +23,12 @@ To install:
 pip install nodejs-bin
 ```
 
+By default the command line `node`, `npm` and `npx` commands are not installed to prevent collisions with already installed Node.js versions. To install them:
+
+```shell
+pip install 'nodejs-bin[cmd]'
+```
+
 You can specify the Node.js version to install with:
 
 ```shell
@@ -39,13 +45,22 @@ To run Node.js from the command line, use:
 
 ```shell
 python -m nodejs
-# or (see below)
-node
 ```
 
-`npm` and `npx` are also available as `python -m nodejs.npm` and `python -m nodejs.npx`.
+`npm` and `npx` are also available as `nodejs.npm` and `nodejs.npx`:
+
+```shell
+python -m nodejs.npm
+python -m nodejs.npx
+```
+
+If you installed the optional command line commands with `pip install 'nodejs-bin[cmd]'` (see above), you can use them directly from the command line as you would normally with Node.js:
 
-Additionally, the standard `node`, `npm` and `npx` commands are also added to your Python environment's `bin` directory. This is usually on your `PATH` and so they should be available in your shell environment.
+```shell
+node
+npm
+npx
+```
 
 Python API Usage
 ----------------
@@ -113,6 +128,14 @@ Finally, there are a number of convenient attributes on the `nodejs` module:
   * `nodejs.path`: the path to the Node.js executable.
 
 
+Versions
+--------
+
+nodejs-bin offers Node.js *Current* and *LTS* (long-term support) versions. See the [Node.js Documentation](https://nodejs.org/en/about/releases/) for more information.
+
+The full list of versions is available on PyPI is here: <https://pypi.org/project/nodejs-bin/#history>
+
+
 License
 -------
 

make_wheels.py

@@ -14,7 +14,6 @@
 # Suffix to append to the Wheel
 # For pre release versions this should be 'aN', e.g. 'a1'
 # For release versions this should be ''
-# If replacing a release version, this should be a build tag '-N', e.g. '-1'.
 # See https://peps.python.org/pep-0427/#file-name-convention for details.
 BUILD_SUFFIX = 'a2'
 
@@ -87,12 +86,13 @@ def write_wheel(out_dir, *, name, version, tag, metadata, description, contents,
     name_snake = name.replace('-', '_')
     wheel_name = f'{name_snake}-{version}-{tag}.whl'
     dist_info  = f'{name_snake}-{version}.dist-info'
-    return write_wheel_file(os.path.join(out_dir, wheel_name), {
-        **contents,
-        f'{dist_info}/entry_points.txt': (cleandoc("""
+    if entry_points:
+        contents[f'{dist_info}/entry_points.txt'] = (cleandoc("""
             [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'),
+    return write_wheel_file(os.path.join(out_dir, wheel_name), {
+        **contents,
         f'{dist_info}/METADATA': make_message({
             'Metadata-Version': '2.1',
             'Name': name,
@@ -129,7 +129,7 @@ def write_nodejs_wheel(out_dir, *, node_version, version, platform, archive):
             contents[zip_info] = b''.join(entry.get_blocks())
 
             if entry_name in NODE_BINS:
-                entry_points['node'] = 'nodejs.node:main'
+                # entry_points['node'] = 'nodejs.node:main'
                 contents['nodejs/node.py'] = cleandoc(f"""
                     import os, sys, subprocess
 
@@ -166,7 +166,7 @@ def 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'
+                # 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'] = cleandoc(f"""
                     import os, sys
@@ -197,7 +197,7 @@ def 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'
+                # 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'] = cleandoc(f"""
                     import os, sys, subprocess
 
@@ -245,6 +245,8 @@ def main():
                 'Node.js Homepage, https://nodejs.org',
             ],
             'Requires-Python': '~=3.5',
+            'Provides-Extra': 'cmd',
+            'Requires-Dist': "nodejs-cmd; extra == 'cmd'",
         },
         description=description,
         contents=contents,

nodejs-cmd/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2022 Sam Willis
+
+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.

nodejs-cmd/README.md

@@ -0,0 +1,9 @@
+# Additional Standard Command Line Commands For "nodejs-bin"
+
+This package provides the `node`, `npm` and `npx` commands for the (nodejs-bin project)[https://pypi.org/project/nodejs-bin/].
+
+It should not be installed directly, but rather as an option when installing the `nodejs-bin` package:
+
+```shell
+pip install 'nodejs-bin[cmd]'
+```

nodejs-cmd/nodejs_cmd.py

@@ -0,0 +1,10 @@
+from nodejs import node, npm, npx
+
+def node_main():
+    node.main()
+
+def npm_main():
+    npm.main()
+
+def npx_main():
+    npx.main()

nodejs-cmd/setup.py

@@ -0,0 +1,27 @@
+from setuptools import setup
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setup(
+    name='nodejs-cmd',
+    version='0.0.1a',
+    author="Sam Willis",
+    description="Additional Standard Command Line Commands For nodejs-bin",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/samwillis/nodejs-pypi",
+    py_modules=['nodejs_cmd'],
+    classifiers=[
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='~=3.5',
+    entry_points={
+        'console_scripts': [
+            'node = nodejs_cmd:node_main',
+            'npm = nodejs_cmd:npm_main',
+            'npx = nodejs_cmd:npx_main',
+        ],
+    },
+)