8.0 Deployment

.ci/BHoMBot/Nuget/BHoM.Interop.Python.nuspec

@@ -21,6 +21,8 @@
     </dependencies>
   </metadata>
   <files>
+    <file src="C:\ProgramData\BHoM\Extensions\PythonCode\Python_Toolkit\src\python_toolkit\bhom\wrapped\**\*.*" exclude="**\__pycache__\*;**\docs\**\*" target="contentFiles\any\any\PythonCode\Python_Toolkit\src\python_toolkit\bhom\wrapped"/>
+    <file src="C:\ProgramData\BHoM\Extensions\PythonCode\Python_Toolkit\src\**\*.*" exclude="**\__pycache__\*;**\docs\**\*" target="contentFiles\any\any\PythonEnvironment\Lib\site-packages" />
     <file src="licence/licence.txt" target="" />
     <file src="images/icon.png" target="" />
     <file src="docs/readme.md" target="" />

.gitignore

@@ -98,4 +98,123 @@ Alligator/Alligator_REMOTE_9848.csproj
 
 # User defined files #
 ######################
-build.ps1
+build.ps1
+
+# Testing files
+.dev/
+prototypes/
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+*.ipynb
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# unignored files
+!example.sql

Python_Engine/Compute/BasePythonEnvironment.cs

@@ -33,11 +33,14 @@ namespace BH.Engine.Python
 {
     public static partial class Compute
     {
+        [PreviousVersion("8.0", "BH.Engine.Python.Compute.BasePythonEnvironment(System.Boolean, System.Boolean)")]
         [Description("Retrieve or reinstall the base Python Environment for BHoM workflows.")]
+        [Input("version", "The target version of python to be installed or retrieved.")]
         [Input("reload", "Reload the base Python environment rather than recreating it, if it already exists.")]
         [Input("run", "Start the installation/retrieval of the BHoM Base Python Environment.")]
         [Output("env", "The base Python Environment for all BHoM workflows.")]
         public static PythonEnvironment BasePythonEnvironment(
+            PythonVersion version = PythonVersion.v3_10,
             bool reload = true,
             bool run = false
         )
@@ -52,10 +55,10 @@ public static PythonEnvironment BasePythonEnvironment(
                 // create PythonEnvironments directory if it doesnt already exist
                 Directory.CreateDirectory(Query.DirectoryEnvironments());
             }
-            
+
             // determine whether the base environment already exists
-            string targetExecutable = Path.Combine(Query.DirectoryBaseEnvironment(), "python.exe");
-            bool exists = Directory.Exists(Query.DirectoryBaseEnvironment()) && File.Exists(targetExecutable);
+            string targetExecutable = Path.Combine(Query.DirectoryBaseEnvironment(version), "python.exe");
+            bool exists = File.Exists(targetExecutable);
 
             if (exists && reload)
                 return new PythonEnvironment() { Name = Query.ToolkitName(), Executable = targetExecutable };
@@ -64,50 +67,14 @@ public static PythonEnvironment BasePythonEnvironment(
                 // remove all existing environments and kernels
                 RemoveEverything();
 
-            // download the target Python version and convert into a "full" python installation bypassing admin rights
-            string executable = PythonVersion.v3_10_5.DownloadPython(Query.ToolkitName());
-            string pipInstaller = DownloadGetPip(Path.GetDirectoryName(executable));
-            string baseEnvironmentDirectory = Path.GetDirectoryName(executable);
-
-            // install pip into the python installation
-            Process process = new Process()
-            {
-                StartInfo = new ProcessStartInfo()
-                {
-                    FileName = Modify.AddQuotesIfRequired(executable),
-                    Arguments = Modify.AddQuotesIfRequired(pipInstaller) + " --no-warn-script-location",
-                    RedirectStandardError=true,
-                    UseShellExecute=false,
-                }
-            };
-            using (Process p = Process.Start(process.StartInfo))
-            {
-                string standardError = p.StandardError.ReadToEnd();
-                p.WaitForExit();
-                if (p.ExitCode != 0)
-                    BH.Engine.Base.Compute.RecordError($"Error installing pip.\n{standardError}");
-                File.Delete(pipInstaller);
-            }
-
-            // delete files with the suffix ._pth from installedDirectory
-            List<string> pthFiles = Directory.GetFiles(baseEnvironmentDirectory, "*.*", SearchOption.TopDirectoryOnly).Where(s => s.EndsWith("._pth")).ToList();
-            foreach (string pthFile in pthFiles)
-            {
-                File.Delete(pthFile);
-            }
-
-            // move files with the suffix .dll and .pyd from installedDirectory into a DLLs directory
-            string libDirectory = Directory.CreateDirectory(Path.Combine(baseEnvironmentDirectory, "DLLs")).FullName;
-            List<string> libFiles = Directory.GetFiles(baseEnvironmentDirectory, "*.*", SearchOption.TopDirectoryOnly).Where(s => (s.EndsWith(".dll") || s.EndsWith(".pyd")) && !Path.GetFileName(s).Contains("python") && !Path.GetFileName(s).Contains("vcruntime")).ToList();
-            foreach (string libFile in libFiles)
-            {
-                File.Move(libFile, Path.Combine(libDirectory, Path.GetFileName(libFile)));
-            }
+            // download and run the installer for the target Python version
+            string exe = version.DownloadPythonVersion();
 
             // install essential packages into base environment
-            InstallPackages(executable, new List<string>() { "virtualenv", "jupyterlab", "black", "pylint" });
+            InstallPackages(exe, new List<string>() { "virtualenv", "jupyterlab", "black", "pylint" });
+            InstallPackageLocal(exe, Path.Combine(Query.DirectoryCode(), Query.ToolkitName()));
 
-            return new PythonEnvironment() { Name = Query.ToolkitName(), Executable = executable };
+            return new PythonEnvironment() { Name = Query.ToolkitName(), Executable = exe };
         }
     }
 }

Python_Engine/Compute/Download.cs

@@ -24,7 +24,9 @@
 using BH.oM.Python.Enums;
 using System;
 using System.ComponentModel;
+using System.Diagnostics;
 using System.IO;
+using System.Reflection;
 using System.Xml.Linq;
 
 namespace BH.Engine.Python
@@ -85,34 +87,53 @@
             return filePath;
         }
 
-        // TODO - THIS METHOD HAS CHANGED BUT IS STILL USED, SO NEEDS DEPRECATING
-        // changed from what to what ? 
-        [Description("Download the target version of Python.")]
-        [Input("version", "A Python version.")]
-        [Input("name", "Name of target exe file.")]
-        [Output("executablePath", "The path of the executable for the downloaded Python.")]
-        public static string DownloadPython(this PythonVersion version, string name = null)
+        /******************************************************/
+
+        [PreviousVersion("8.0", "BH.Engine.Python.Compute.DownloadPython(BH.oM.Python.Enums.PythonVersion, System.String)")]
+        [Description("Download and install a specified version of python, and return the executable for it.")]
+        [Input("version", "The version of python to download.")]
+        [Output("pythonExecutable", "The executable (python.exe) for the python version that was installed")]
+        public static string DownloadPythonVersion(this PythonVersion version)
         {
             string url = version.EmbeddableURL();
-            if (string.IsNullOrEmpty(name))
-                name = Path.GetFileNameWithoutExtension(url);
-            string targetExecutable = Path.Combine(Query.DirectoryEnvironments(), name, "python.exe");
-
-            if (File.Exists(targetExecutable))
-                return targetExecutable;
-
-            string zipfile = DownloadFile(url, Query.DirectoryEnvironments());
-            UnzipFile(zipfile, Query.DirectoryEnvironments(), name, true);
-
-            return targetExecutable;
-        }
 
-        [Description("Download the pip installer")]
-        [Input("targetDirectory", "The directory into which get-pip.py will be downloaded.")]
-        [Output("getpipPath", "The path of the file used to install pip into an embedded Python environment.")]
-        public static string DownloadGetPip(string targetDirectory)
-        {
-            return DownloadFile("https://bootstrap.pypa.io/get-pip.py", targetDirectory);
+            string basePath = Path.Combine(Query.DirectoryBaseEnvironment(version));
+
+            if (File.Exists(Path.Combine(basePath, "python.exe")))
+                return Path.Combine(basePath, "python.exe");
+
+            if (!Directory.Exists(basePath))
+                Directory.CreateDirectory(basePath);
+            else
+            {
+                Directory.Delete(basePath, true); //if there are any files here already for some reason, remove them.
+                Directory.CreateDirectory(basePath);
+            }
+
+            string installerFile = DownloadFile(url, basePath, "installer.exe");
+
+            using (Process install = new Process()
+            {
+                StartInfo = new ProcessStartInfo()
+                {
+                    FileName = installerFile,
+                    Arguments = $"/passive InstallAllUsers=0 InstallLauncherAllUsers=0 Include_launcher=0 Shortcuts=0 AssociateFiles=0 Include_tools=0 Include_test=0 TargetDir={Modify.AddQuotesIfRequired(basePath)}",
+                    RedirectStandardError = true,
+                    UseShellExecute = false,
+                }
+            })
+            {
+                install.Start();
+                string stderr = install.StandardError.ReadToEnd();
+                install.WaitForExit();
+                if (install.ExitCode != 0)
+                {
+                    BH.Engine.Base.Compute.RecordError($"Error installing python: {stderr}");
+                    return null;
+                }
+            }
+
+            return Path.Combine(basePath, "python.exe");
         }
     }
 }

Python_Engine/Compute/Remove.cs

@@ -21,7 +21,11 @@
  */
 
 using BH.oM.Base.Attributes;
+using BH.oM.Python.Enums;
+using System;
+using System.Collections.Generic;
 using System.ComponentModel;
+using System.Diagnostics;
 using System.IO;
 
 namespace BH.Engine.Python
@@ -77,19 +81,60 @@ public static void RemoveAllVirtualEnvironments()
             }
         }
 
-        [Description("Completely remove the base BHoM Python environment.")]
-        public static void RemoveBaseEnvironment()
+        [PreviousVersion("8.0", "BH.Engine.Python.Compute.RemoveBaseEnvironment()")]
+        [Description("Remove the base install for the python version specified.")]
+        [Input("version", "The base python version to remove.")]
+        public static void RemoveBaseVersion(PythonVersion version = PythonVersion.v3_10)
         {
-            string basePath = Path.Combine(Query.DirectoryEnvironments(), Query.ToolkitName());
-            if (Directory.Exists(basePath))
+            string basePath = Path.Combine(Query.DirectoryEnvironments(), Query.ToolkitName(), version.ToString());
+            string baseInstaller = Path.Combine(basePath, "installer.exe");
+
+            // If the installer does not exist and the folder does - assume a bad/invalid install and just delete the entire folder.
+            if (!File.Exists(baseInstaller) && Directory.Exists(basePath))
+            {
                 Directory.Delete(basePath, true);
+                return;
+            }
+            else if (!Directory.Exists(basePath))
+                // If the base path doesn't exist there is nothing to remove.
+                return;
+
+            using (Process uninstall = new Process()
+            {
+                StartInfo = new ProcessStartInfo()
+                {
+                    FileName = baseInstaller,
+                    Arguments = "/uninstall /passive",
+                    RedirectStandardError = true,
+                    UseShellExecute = false,
+                }
+            })
+            {
+                uninstall.Start();
+                string stderr = uninstall.StandardError.ReadToEnd();
+                uninstall.WaitForExit();
+                if (uninstall.ExitCode != 0)
+                {
+                    BH.Engine.Base.Compute.RecordError($"Error uninstalling python: {stderr}");
+                    return;
+                }
+            }
+
+            // Finally remove base folder as the installer may have missed something.
+            Directory.Delete(basePath, true);
         }
 
         [Description("Completely remove all BHoM-related Python environments and kernels.")]
         public static void RemoveEverything()
         {
             RemoveAllVirtualEnvironments();
-            RemoveBaseEnvironment();
+
+            //remove all python versions installed in base directory.
+            foreach (PythonVersion e in Enum.GetValues(typeof(PythonVersion)))
+            {
+                if (e != PythonVersion.Undefined)
+                    RemoveBaseVersion(e);
+            }
         }
     }
 }

Python_Engine/Compute/UnzipFile.cs

@@ -29,6 +29,7 @@ namespace BH.Engine.Python
 {
     public static partial class Compute
     {
+        //This method is no longer used by python toolkit, and perhaps should be removed or moved to the file toolkit instead.
         [Description("Extract the contents of an archive.")]
         [Input("archivePath", "The archive to extract.")]
         [Input("targetDirectory", "The destination directory to extract into.")]