7.0 Deployment (#129)

Author: Fraser Greenroyd

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

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package>
+  <metadata>
+    <id>BHoM.Interop.Python</id>
+    <version></version>
+    <authors>BHoM</authors>
+    <projectUrl>https://github.com/BHoM/Python_Toolkit</projectUrl>
+    <license type="file">licence.txt</license>
+    <icon>icon.png</icon>
+    <readme>readme.md</readme>
+    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <description>Interact with Python via BHoM</description>
+    <releaseNotes></releaseNotes>
+    <copyright></copyright>
+    <tags>BHoM engine aec Python</tags>
+    <title></title>
+    <dependencies>
+      <group targetFramework="netstandard2.0">
+        <dependency id="NETStandard.Library" version="2.0.3" />
+      </group>
+    </dependencies>
+  </metadata>
+  <files>
+    <file src="licence/licence.txt" target="" />
+    <file src="images/icon.png" target="" />
+    <file src="docs/readme.md" target="" />
+  </files>
+</package>

Python_Engine/Compute/BasePythonEnvironment.cs

@@ -35,12 +35,19 @@ public static partial class Compute
     {
         [Description("Retrieve or reinstall the base Python Environment for BHoM workflows.")]
         [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.")]
-        [PreviousVersion("6.3", "BH.Engine.Python.Compute.InstallBasePythonEnvironment(System.Boolean)")]
+        [PreviousVersion("7.0", "BH.Engine.Python.Compute.BasePythonEnvironment(System.Boolean)")]
         public static PythonEnvironment BasePythonEnvironment(
-            bool reload = true
+            bool reload = true,
+            bool run = false
         )
         {
+            if (!run)
+            {
+                return null;
+            }
+
             if (!Directory.Exists(Query.DirectoryEnvironments()))
             {
                 // create PythonEnvironments directory if it doesnt already exist

Python_Engine/Compute/Download.cs

@@ -91,7 +91,6 @@ public static string DownloadFile(
         [Input("version", "A Python version.")]
         [Input("name", "Name of target exe file.")]
         [Output("executablePath", "The path of the executable for the downloaded Python.")]
-        [PreviousVersion("6.3", "BH.Engine.Python.Compute.DownloadPython(BH.oM.Python.Enums.PythonVersion)")]
         public static string DownloadPython(this PythonVersion version, string name = null)
         {
             string url = version.EmbeddableURL();

Python_Engine/Compute/InstallPackage.cs

@@ -27,7 +27,6 @@
 using System.ComponentModel;
 using System.Diagnostics;
 using System.IO;
-using System.Windows.Forms;
 using System.Xml.Linq;
 
 namespace BH.Engine.Python

Python_Engine/Compute/VirtualEnvironment.cs

@@ -23,7 +23,6 @@
 using BH.oM.Base.Attributes;
 using BH.oM.Python;
 using BH.oM.Python.Enums;
-using Microsoft.SqlServer.Server;
 using System.Collections.Generic;
 using System.ComponentModel;
 using System.Diagnostics;

Python_Engine/Properties/AssemblyInfo.cs

@@ -1,35 +1,21 @@
-<?xml version="1.0" encoding="utf-8"?>
-<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+<Project Sdk="Microsoft.NET.Sdk">
+
   <PropertyGroup>
-    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
-    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
-    <ProjectGuid>{4A6B3805-35EE-4278-9701-CC1E0CD641F9}</ProjectGuid>
-    <OutputType>Library</OutputType>
-    <AppDesignerFolder>Properties</AppDesignerFolder>
+    <TargetFramework>netstandard2.0</TargetFramework>
+    <AssemblyVersion>7.0.0.0</AssemblyVersion>
+    <Description>https://github.com/BHoM/Python_Toolkit</Description>
+    <Version>6.0.0</Version>
+    <Authors>BHoM</Authors>
+    <Copyright>Copyright © https://github.com/BHoM</Copyright>
     <RootNamespace>BH.Engine.Python</RootNamespace>
-    <AssemblyName>Python_Engine</AssemblyName>
-    <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
-    <FileAlignment>512</FileAlignment>
-    <Deterministic>true</Deterministic>
-  </PropertyGroup>
-  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
-    <DebugSymbols>true</DebugSymbols>
-    <DebugType>full</DebugType>
-    <Optimize>false</Optimize>
-    <OutputPath>..\Build\</OutputPath>
-    <DefineConstants>DEBUG;TRACE</DefineConstants>
-    <ErrorReport>prompt</ErrorReport>
-    <WarningLevel>0</WarningLevel>
-  </PropertyGroup>
-  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
-    <DebugType>pdbonly</DebugType>
-    <Optimize>true</Optimize>
+    <FileVersion>7.0.0.0</FileVersion>
     <OutputPath>..\Build\</OutputPath>
-    <DefineConstants>TRACE</DefineConstants>
-    <ErrorReport>prompt</ErrorReport>
-    <WarningLevel>4</WarningLevel>
   </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Python_oM\Python_oM.csproj" />
+  </ItemGroup>
+
   <ItemGroup>
     <Reference Include="BHoM">
       <SpecificVersion>False</SpecificVersion>
@@ -41,10 +27,6 @@
       <Private>False</Private>
       <SpecificVersion>False</SpecificVersion>
     </Reference>
-    <Reference Include="Python.Runtime, Version=3.7.4.0, Culture=neutral, processorArchitecture=MSIL">
-      <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\libs\Python.Runtime.dll</HintPath>
-    </Reference>
     <Reference Include="Reflection_Engine">
       <SpecificVersion>False</SpecificVersion>
       <HintPath>$(ProgramData)\BHoM\Assemblies\Reflection_Engine.dll</HintPath>
@@ -55,74 +37,14 @@
       <HintPath>$(ProgramData)\BHoM\Assemblies\Serialiser_Engine.dll</HintPath>
       <Private>False</Private>
     </Reference>
-    <Reference Include="System" />
-    <Reference Include="System.Core" />
-    <Reference Include="System.IO.Compression.FileSystem" />
-    <Reference Include="System.Windows.Forms" />
-    <Reference Include="System.Xml.Linq" />
-    <Reference Include="System.Data.DataSetExtensions" />
-    <Reference Include="Microsoft.CSharp" />
-    <Reference Include="System.Data" />
-    <Reference Include="System.Net.Http" />
-    <Reference Include="System.Xml" />
-  </ItemGroup>
-  <ItemGroup>
-    <Compile Include="Compute\Run.cs" />
-    <Compile Include="Compute\BasePythonEnvironment.cs" />
-    <Compile Include="Compute\Remove.cs" />
-    <Compile Include="Compute\InstallPackage.cs" />
-    <Compile Include="Compute\RequirementsTxt.cs" />
-    <Compile Include="Compute\VirtualEnvironment.cs" />
-    <Compile Include="Compute\UnzipFile.cs" />
-    <Compile Include="Compute\Download.cs" />
-    <Compile Include="Convert\ToPython.cs" />
-    <Compile Include="Modify\AddQuotesIfRequired.cs" />
-    <Compile Include="Query\VirtualEnvironment.cs" />
-    <Compile Include="Query\Version.cs" />
-    <Compile Include="Query\Directory.cs" />
-    <Compile Include="Query\IsValidEnvironmentName.cs" />
-    <Compile Include="Query\EmbeddableURL.cs" />
-    <Compile Include="Query\ToolkitName.cs" />
-    <Compile Include="Properties\AssemblyInfo.cs" />
-  </ItemGroup>
-  <ItemGroup>
-    <None Include="packages.config" />
-    <None Include="Versioning_53.json" />
   </ItemGroup>
-  <ItemGroup>
-    <ProjectReference Include="..\Python_oM\Python_oM.csproj">
-      <Project>{3BF9F725-F1CA-432F-A549-557324CAFB91}</Project>
-      <Name>Python_oM</Name>
-      <Private>False</Private>
-    </ProjectReference>
-  </ItemGroup>
-  <ItemGroup>
-    <Folder Include="Create\" />
-  </ItemGroup>
-  <ItemGroup>
-    <Content Include="Python\src\python_toolkit\bhomutil\__init__.py" />
-    <Content Include="Python\src\python_toolkit\__init__.py" />
-    <None Include="Python\README.md" />
-    <Content Include="Python\setup.py" />
-    <Content Include="Python\requirements.txt" />
-  </ItemGroup>
-  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
-  <PropertyGroup>
-    <PostBuildEvent>
-      xcopy "$(TargetDir)$(TargetFileName)" "C:\\ProgramData\\BHoM\\Assemblies" /Y
-      xcopy "$(TargetDir)Python.Runtime.dll" "C:\\ProgramData\\BHoM\\Assemblies" /Y
-    </PostBuildEvent>
-  </PropertyGroup>
-  <PropertyGroup>
-    <PreBuildEvent>
-      if not exist "C:\ProgramData\BHoM\Extensions\PythonEnvironments" mkdir "C:\ProgramData\BHoM\Extensions\PythonEnvironments"
-      if not exist "C:\ProgramData\BHoM\Extensions\PythonCode" mkdir "C:\ProgramData\BHoM\Extensions\PythonCode"
-      
-      if exist "C:\ProgramData\BHoM\Extensions\PythonCode\$(SolutionName)" rmdir "C:\ProgramData\BHoM\Extensions\PythonCode\$(SolutionName)" /S /Q
-      mkdir "C:\ProgramData\BHoM\Extensions\PythonCode\$(SolutionName)"
-      
-      robocopy "$(ProjectDir)Python" "C:\ProgramData\BHoM\Extensions\PythonCode\$(SolutionName)" /mir /xf "*.pyc" "*.ipynb" /xd "__*__" ".*" &gt; output.log
-      del output.log
-    </PreBuildEvent>
-  </PropertyGroup>
-</Project>
+
+  <Target Name="PostBuild" AfterTargets="PostBuildEvent">
+    <Exec Command="xcopy $(TargetDir)$(TargetFileName) $(ProgramData)\BHoM\Assemblies /Y" />
+  </Target>
+
+  <Target Name="PreBuild" BeforeTargets="PreBuildEvent">
+    <Exec Command="if not exist $(ProgramData)\BHoM\Extensions\PythonEnvironments mkdir $(ProgramData)\BHoM\Extensions\PythonEnvironments&#xD;&#xA;if not exist $(ProgramData)\BHoM\Extensions\PythonCode mkdir $(ProgramData)\BHoM\Extensions\PythonCode&#xD;&#xA;      &#xD;&#xA;if exist $(ProgramData)\BHoM\Extensions\PythonCode\$(SolutionName) rmdir $(ProgramData)\BHoM\Extensions\PythonCode\$(SolutionName) /S /Q&#xD;&#xA;mkdir $(ProgramData)\BHoM\Extensions\PythonCode\$(SolutionName)&#xD;&#xA;      &#xD;&#xA;robocopy $(ProjectDir)Python $(ProgramData)\BHoM\Extensions\PythonCode\$(SolutionName) /mir /xf &quot;*.pyc&quot; &quot;*.ipynb&quot; /xd &quot;__*__&quot; &quot;.*&quot; &gt; output.log&#xD;&#xA;del output.log" />
+  </Target>
+
+</Project>

Python_Engine/Python_Engine.csproj

@@ -33,28 +33,38 @@ public static partial class Query
         [Output("The location where BHoM extensions reside.")]
         public static string DirectoryExtensions()
         {
-            return @"C:\ProgramData\BHoM\Extensions";
+            return Path.Combine(System.IO.Directory.GetParent(BH.Engine.Base.Query.BHoMFolder()).FullName, "Extensions");
         }
 
         [Description("The location where any BHoM-related Python kernels reside.")]
         [Output("The location where any BHoM-related Python kernels reside.")]
         public static string DirectoryKernels()
         {
-            return @"C:\ProgramData\jupyter\kernels";
+            
+            string dir = Path.Combine(System.Environment.GetFolderPath(System.Environment.SpecialFolder.CommonApplicationData), "jupyter", "kernels");
+            if (!Directory.Exists(dir))
+                Directory.CreateDirectory(dir);
+            return dir;
         }
 
         [Description("The location where any BHoM-related Python code resides.")]
         [Output("The location where any BHoM-related Python code resides.")]
         public static string DirectoryCode()
         {
-            return Path.Combine(Query.DirectoryExtensions(), "PythonCode");
+            string dir = Path.Combine(Query.DirectoryExtensions(), "PythonCode");
+            if (!Directory.Exists(dir))
+                Directory.CreateDirectory(dir);
+            return dir;
         }
 
         [Description("The location where any BHoM-related Python environment (or virtualenv) resides.")]
         [Output("The location where any BHoM-related Python environment (or virtualenv) resides.")]
         public static string DirectoryEnvironments()
         {
-            return Path.Combine(Query.DirectoryExtensions(), "PythonEnvironments");
+            string dir = Path.Combine(Query.DirectoryExtensions(), "PythonEnvironments");
+            if (!Directory.Exists(dir))
+                Directory.CreateDirectory(dir);
+            return dir;
         }
 
         [Description("The location where the base Python environment exists.")]

Python_Engine/Query/Directory.cs

@@ -37,7 +37,6 @@ public static partial class Query
         [Description("Check whether a string is valid as BHoM Python Environment name.")]
         [Input("name", "The name given to the BHoM Python Environment.")]
         [Output("valid", "True if valid, False if not.")]
-        [PreviousVersion("6.3","BH.Engine.Python.Compute.IsValidEnvironmentName(System.String)")]
         public static bool IsValidEnvironmentName(string name)
         {
             List<char> invalidChars = new List<char>() { ' ' };

Python_Engine/Query/IsValidEnvironmentName.cs

@@ -36,6 +36,11 @@ public static partial class Query
         [Output("version", "Python version of the requested Python executable.")]
         public static PythonVersion Version(string pythonExecutable)
         {
+            if (!File.Exists(pythonExecutable)) 
+            {
+                return PythonVersion.Undefined;
+            }
+
             Process process = new Process()
             {
                 StartInfo = new ProcessStartInfo()
@@ -47,16 +52,25 @@ public static PythonVersion Version(string pythonExecutable)
                     UseShellExecute = false,
                 }
             };
-            string versionString;
-            using (Process p = Process.Start(process.StartInfo))
+
+            try
+            {
+                string versionString;
+                using (Process p = Process.Start(process.StartInfo))
+                {
+                    p.WaitForExit();
+                    if (p.ExitCode != 0)
+                        BH.Engine.Base.Compute.RecordError($"Error getting Python version.\n{p.StandardError.ReadToEnd()}");
+                    versionString = p.StandardOutput.ReadToEnd().TrimEnd();
+                }
+
+                return (PythonVersion)Enum.Parse(typeof(PythonVersion), "v" + versionString.Replace("Python ", "").Replace(".", "_"));
+            }
+            catch
             {
-                p.WaitForExit();
-                if (p.ExitCode != 0)
-                    BH.Engine.Base.Compute.RecordError($"Error getting Python version.\n{p.StandardError.ReadToEnd()}");
-                versionString = p.StandardOutput.ReadToEnd().TrimEnd();
+                return PythonVersion.Undefined;
             }
 
-            return (PythonVersion) Enum.Parse(typeof(PythonVersion), "v" + versionString.Replace("Python ", "").Replace(".", "_"));
         }
     }
 }