Add documentation to nodejs port and python port about metacall cli for launching the scripts. EnaAdapt python port to the new way of install distributable tarballs.

Author: viferga

source/ports/node_port/README.md

@@ -36,3 +36,7 @@ metacall_load_from_file('py', [ 'sum.py' ]);
 
 metacall('sum', 3, 4); // 7
 ```
+
+``` sh
+metacall node main.js
+```

source/ports/py_port/package/README.rst

@@ -12,24 +12,42 @@ Programming Language. With **METACALL** Python Port you can
 transparently execute code from Python to any programming language, for
 example, calling JavaScript, NodeJS, Ruby or C# code from Python.
 
+Install
+========
+
+Install MetaCall binaries first:
+
+.. code:: console
+
+   curl -sL https://raw.githubusercontent.com/metacall/install/master/install.sh | bash
+
+Then install Python package:
+
 .. code:: console
 
    pip install metacall
 
-``sum.js``
+Example
+========
+
+``multiply.rb``
 
-.. code:: javascript
+.. code:: ruby
 
-   module.exports = function sum(a, b) {
-       return a + b;
-   };
+    def multiply(left, right)
+        return left * right
+    end
 
 ``main.py``
 
 .. code:: python
 
    from metacall import metacall_load_from_file, metacall
 
-   metacall_load_from_file('node', [ 'sum.js' ]);
+   metacall_load_from_file('rb', [ 'multiply.rb' ]);
+
+   metacall('multiply', 3, 4); # 12
+
+.. code:: console
 
-   metacall('sum', 3, 4); # 7
+   metacall py main.py

source/ports/py_port/package/helper/__init__.py

@@ -17,6 +17,8 @@
 #	See the License for the specific language governing permissions and
 #	limitations under the License.
 
+# TODO: Update to the new install / distributable tarballs
+
 import sys
 import os
 import re
@@ -223,7 +225,7 @@ def uninstall_prompt():
 * this action DOES NOT uninstall the python package, only MetaCall CLI and MetaCall libs
 * for a complete uninstall you have to run metacall-uninstall && pip uninstall metacall 
 * (the order of execution is important)
-  
+
 Proceed (y/n)? '''.format(''.join('''{}\n   '''.format(l) for l in paths))
 
 	answers = {'yes': True, 'y': True, 'no': False, 'n': False}

source/ports/py_port/package/metacall/__init__.py

@@ -19,14 +19,34 @@
 
 import os
 import sys
+import re
 
-sys.path.append(os.environ.get('PORT_LIBRARY_PATH', '/usr/local/lib'));
+# Append environment variable or default install path when building manually (TODO: Cross-platform paths)
+sys.path.append(os.environ.get('PORT_LIBRARY_PATH', os.path.join(os.path.sep, 'usr', 'local', 'lib')));
+
+# Find is MetaCall is installed as a distributable tarball (TODO: Cross-platform paths)
+rootdir = os.path.join(os.path.sep, 'gnu', 'store')
+regex = re.compile('.*-metacall-.*')
+
+for root, dirs, _ in os.walk(rootdir):
+	for folder in dirs:
+		if regex.match(folder) and not folder.endswith('R'):
+			sys.path.append(os.path.join(rootdir, folder, 'lib'))
 
 try:
 	from _py_port import * # TODO: Import only the functions that will be exported
 except ImportError as e:
 	try:
+		print('Error when importing MetaCall Python Port:', e);
 		from _py_portd import * # TODO: Import only the functions that will be exported
-	except ImportError as ed:
-		print("MetaCall Core is not correctly installed:", e, "-", ed)
+		print('MetaCall Python Port Debug Imported');
+	except ImportError as e:
+		print('\x1b[31m\x1b[1m', 'You do not have MetaCall installed or we cannot find it (', e, ')\x1b[0m');
+		print('\x1b[33m\x1b[1m', 'If you do not have it installed, you have three options:', '\x1b[0m');
+		print('\x1b[1m', '	1) Go to https://github.com/metacall/install and install it.', '\x1b[0m');
+		print('\x1b[1m', '	2) Contribute to https://github.com/metacall/distributable by providing support for your platform and architecture.', '\033[0m');
+		print('\x1b[1m', '	3) Be a x10 programmer and compile it by yourself, then define the install folder (if it is different from the default /usr/local/lib) in os.environ[\'LOADER_LIBRARY_PATH\'].', '\x1b[0m');
+		print('\x1b[33m\x1b[1m', 'If you have it installed in an non-standard folder, please define os.environ[\'LOADER_LIBRARY_PATH\'].', '\x1b[0m');
 		pass
+
+# TODO: Monkey patch

source/ports/py_port/package/setup.py

@@ -21,6 +21,7 @@
 from codecs import open
 import os
 import sys
+import re
 
 # Always prefer setuptools over distutils
 from setuptools import setup, find_packages
@@ -38,7 +39,7 @@
 	# Versions should comply with PEP440.  For a discussion on single-sourcing
 	# the version across setup.py and the project code, see
 	# https://packaging.python.org/en/latest/single_source_version.html
-	'version': '0.1.11',
+	'version': '0.1.17',
 
 	'description': 'A library for providing inter-language foreign function interface calls',
 	'long_description': long_description,
@@ -117,7 +118,17 @@
 # Detect if metacall port is already installed
 port_installed = False
 
-sys.path.append(os.environ.get('PORT_LIBRARY_PATH', '/usr/local/lib'));
+# Append environment variable or default install path when building manually (TODO: Cross-platform paths)
+sys.path.append(os.environ.get('PORT_LIBRARY_PATH', os.path.join(os.path.sep, 'usr', 'local', 'lib')));
+
+# Find is MetaCall is installed as a distributable tarball (TODO: Cross-platform paths)
+rootdir = os.path.join(os.path.sep, 'gnu', 'store')
+regex = re.compile('.*-metacall-.*')
+
+for root, dirs, _ in os.walk(rootdir):
+	for folder in dirs:
+		if regex.match(folder) and not folder.endswith('R'):
+			sys.path.append(os.path.join(rootdir, folder, 'lib'))
 
 # Find if module is installed
 if sys.version_info[0] < 3:
@@ -149,29 +160,36 @@
 		py_port = importlib.util.find_spec("_py_portd")
 		port_installed = py_port is not None
 
-if port_installed == True:
-	# Exclude helper package if port is already installed
-	exclude_packages.append('helper')
-else:
-	# List run-time dependencies here.  These will be installed by pip when
-	# your project is installed. For an analysis of "install_requires" vs pip's
-	# requirements files see:
-	# https://packaging.python.org/en/latest/requirements.html
-	options['install_requires'] = ['peppercorn', 'requests']
-
-	# Define install hooks
-	# TODO
-
-	# To provide executable scripts, use entry points in preference to the
-	# "scripts" keyword. Entry points provide cross-platform support and allow
-	# pip to create the appropriate form of executable for the target platform.
-	options['entry_points'] = {
-		'console_scripts': [
-			'metacall-install=helper:install',
-			'metacall-uninstall=helper:uninstall_prompt',
-			'metacall-update=helper:update'
-		],
-	}
+# TODO: This code is very interesting for providing commands to the end user.
+#	pip cannot execute arbitrary code as pre/post install hook when the package is being installed.
+#	So it is impossible to install the binaries unless we add extra commands after install.
+#	At this moment there is a common solution for installing binaries depending on Bash/PowerShell
+#	that is OS dependant and not language dependant. By the moment we will use the new way of install
+#	instead of the old one, but we keep the ./helper folder in order to provide future support for
+#	extra commands, although the main idea is to keep the OS dependant install, this can be useful
+#	for updating or doing Python related things. Meanwhile, it will be avoided.
+exclude_packages.append('helper')
+
+# if port_installed == True:
+# 	# Exclude helper package if port is already installed
+# 	exclude_packages.append('helper')
+# else:
+# 	# List run-time dependencies here.  These will be installed by pip when
+# 	# your project is installed. For an analysis of "install_requires" vs pip's
+# 	# requirements files see:
+# 	# https://packaging.python.org/en/latest/requirements.html
+# 	options['install_requires'] = ['peppercorn', 'requests']
+
+# 	# To provide executable scripts, use entry points in preference to the
+# 	# "scripts" keyword. Entry points provide cross-platform support and allow
+# 	# pip to create the appropriate form of executable for the target platform.
+# 	options['entry_points'] = {
+# 		'console_scripts': [
+# 			'metacall-install=helper:install',
+# 			'metacall-uninstall=helper:uninstall_prompt',
+# 			'metacall-update=helper:update'
+# 		],
+# 	}
 
 # Define required packages
 options['packages'] = find_packages(exclude=exclude_packages)

source/ports/py_port/package/upload.sh

@@ -19,14 +19,20 @@
 #	limitations under the License.
 #
 
-# Install dependencies
-python3 -m pip install --user --upgrade twine setuptools wheel
+# TODO: Update version in setup.py
+# TODO: Automate for CD/CI
 
-# Upload MetaCall package
-python3 setup.py sdist bdist_wheel
-python3 -m twine check dist/*
-python3 -m twine upload dist/*
+# Define exit code
+fail=0
+
+# Install dependencies and upload MetaCall package
+python3 -m pip install --user --upgrade twine setuptools wheel \
+	&& python3 setup.py sdist bdist_wheel \
+	&& python3 -m twine check dist/* \
+	&& python3 -m twine upload dist/* || fail=1
 
 # Delete output
-rm -rf dist/*
-rm -rf build/*
+rm -rf dist/* build/* || fail=1
+
+# Exit
+exit ${fail}