Automatic pip package generation (#868)

CMakeLists.txt

@@ -197,3 +197,4 @@ add_subdirectory(src/OMSimulator)
 add_subdirectory(src/OMSimulatorLib)
 add_subdirectory(src/OMSimulatorLua)
 add_subdirectory(src/OMSimulatorPython)
+add_subdirectory(src/pip)

Makefile

@@ -1,4 +1,3 @@
-
 CC ?= gcc
 CXX ?= g++
 LINK ?= $(CXX)
@@ -124,7 +123,7 @@ else
 	CMAKE_BOOST_ROOT="-DBOOST_ROOT=$(BOOST_ROOT)"
 endif
 
-.PHONY: OMSimulator OMSimulatorCore config-OMSimulator config-fmil config-lua config-zlib config-cvode config-kinsol config-3rdParty distclean testsuite doc doc-html doc-doxygen OMTLMSimulator OMTLMSimulatorClean RegEx
+.PHONY: OMSimulator OMSimulatorCore config-OMSimulator config-fmil config-lua config-zlib config-cvode config-kinsol config-3rdParty distclean testsuite doc doc-html doc-doxygen OMTLMSimulator OMTLMSimulatorClean RegEx pip
 
 OMSimulator:
 	@echo OS: $(detected_OS)
@@ -142,6 +141,16 @@ OMSimulatorCore:
 	@echo
 	@$(MAKE) -C $(BUILD_DIR) install
 
+pip:
+	@echo
+	@echo "# make pip"
+	@echo
+	@cd src/pip/install/ && python3 setup.py sdist
+	@echo "########################"
+	@echo "# Run the following command to upload the package"
+	@echo "# > twine upload src/pip/install/dist/*"
+	@echo "########################"
+
 ifeq ($(OMTLM),ON)
 OMTLMSimulator: RegEx
 	@echo

src/pip/.gitignore

@@ -0,0 +1,2 @@
+# generated directories
+/install/

src/pip/CMakeLists.txt

@@ -0,0 +1,7 @@
+project(pip)
+
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/setup.py" "${CMAKE_CURRENT_BINARY_DIR}/setup.py" @ONLY)
+
+install(FILES "${CMAKE_CURRENT_BINARY_DIR}/setup.py" DESTINATION ${CMAKE_CURRENT_SOURCE_DIR}/install/)
+install(FILES "${CMAKE_SOURCE_DIR}/README.md" DESTINATION ${CMAKE_CURRENT_SOURCE_DIR}/install/)
+install(FILES "${CMAKE_SOURCE_DIR}/OSMC-License.txt" DESTINATION ${CMAKE_CURRENT_SOURCE_DIR}/install/)

src/pip/setup.py

@@ -0,0 +1,133 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+__license__ = '''
+This file is part of OpenModelica.
+Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
+c/o Linköpings universitet, Department of Computer and Information Science,
+SE-58183 Linköping, Sweden.
+All rights reserved.
+THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
+THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
+ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
+RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
+ACCORDING TO RECIPIENTS CHOICE.
+The OpenModelica software and the Open Source Modelica
+Consortium (OSMC) Public License (OSMC-PL) are obtained
+from OSMC, either from the above address,
+from the URLs: http://www.ida.liu.se/projects/OpenModelica or
+http://www.openmodelica.org, and in the OpenModelica distribution.
+GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
+This program is distributed WITHOUT ANY WARRANTY; without
+even the implied warranty of  MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
+IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
+See the full OSMC Public License conditions for more details.
+'''
+
+__author__ = 'Open Source Modelica Consortium (OSMC)'
+__maintainer__ = 'https://openmodelica.org'
+__status__ = 'Production'
+
+
+import os
+import platform
+import shutil
+import sysconfig
+import tempfile
+from distutils.command.build_py import build_py
+from distutils.dir_util import copy_tree
+
+import requests
+from setuptools import setup
+
+
+# override build_py, for compiling and copying the dlls
+class my_build_py(build_py):
+  def __init__(self, dist):
+    # check if directory exist and remove
+    topdir = os.path.join(os.getcwd(), 'OMSimulator')
+    if os.path.isdir(topdir):
+      os.rmdir(topdir)
+
+    # recreate it, so that setuptools creates the package directory
+    os.mkdir(topdir)
+
+    build_py.__init__(self, dist)
+
+  def fetch_oms(self):
+    target_dir = os.path.join(self.build_lib, 'OMSimulator')
+
+    # mkpath is a distutils helper to create directories
+    self.mkpath(target_dir)
+
+    # download the zip directory from url
+    if (sysconfig.get_platform() == 'linux-x86_64'):
+      response = requests.get('https://build.openmodelica.org/omsimulator/linux-amd64/OMSimulator-linux-amd64-@OMS_VERSION_STRING@.tar.gz')
+    elif (sysconfig.get_platform() == 'linux-i386'):
+      response = requests.get('https://build.openmodelica.org/omsimulator/linux-i386/OMSimulator-linux-i386-@OMS_VERSION_STRING@.tar.gz')
+    elif (sysconfig.get_platform() == 'linux-arm32'):
+      response = requests.get('https://build.openmodelica.org/omsimulator/linux-arm32/OMSimulator-linux-arm32-@OMS_VERSION_STRING@.tar.gz')
+    elif (sysconfig.get_platform() == 'mingw' and platform.architecture()[0] == '64bit'):
+      response = requests.get('https://build.openmodelica.org/omsimulator/win-mingw64/OMSimulator-mingw64-@OMS_VERSION_STRING@.zip')
+    elif (sysconfig.get_platform() == 'mingw' and platform.architecture()[0] == '32bit'):
+      response = requests.get('https://build.openmodelica.org/omsimulator/win-mingw32/OMSimulator-mingw32-@OMS_VERSION_STRING@.zip')
+    elif (sysconfig.get_platform() == 'win-amd64'):
+      response = requests.get('https://build.openmodelica.org/omsimulator/win-msvc64/OMSimulator-win64-@OMS_VERSION_STRING@.zip')
+    elif (platform.system() == 'Darwin'):
+      response = requests.get('https://build.openmodelica.org/omsimulator/osx/OMSimulator-osx-@OMS_VERSION_STRING@.zip')
+    else:
+      raise Exception("Platform not supported for {} ".format(sysconfig.get_platform()))
+
+    if response.status_code != 200:
+      raise Exception("Downloading artifact failed for {} ".format(response.url))
+
+    zipFileName = os.path.basename(response.url)
+    dirname, extension = os.path.splitext(zipFileName)
+
+    tempDir = tempfile.gettempdir()
+    zipFilePath = os.path.join(tempDir, zipFileName)
+
+    # remove zip file if exists
+    if os.path.exists(zipFilePath):
+      os.remove(zipFilePath)
+
+    # copy the zip file in temp directory
+    zipfile = open(zipFilePath, "wb")
+    zipfile.write(response.content)
+    zipfile.close()
+
+    zipDir = os.path.join(tempDir, dirname)
+    # remove zip directory if exists
+    if os.path.isdir(zipDir):
+      shutil.rmtree(zipDir)
+
+    # unzip the zip file
+    shutil.unpack_archive(zipFilePath, zipDir)
+
+    # copy OMSimulator package to root directory
+    copy_tree(os.path.join(zipDir, 'lib/OMSimulator'), target_dir)
+
+    # remove the zip directory after copying the files
+    shutil.rmtree(zipDir)
+
+    # remove the zip file
+    os.remove(zipFilePath)
+
+  def run(self):
+    if not self.dry_run:
+      self.fetch_oms()
+    build_py.run(self)
+
+setup(name = 'OMSimulator',
+      version = '@OMS_SHORT_VERSION_STRING@',
+      description = 'OMSimulator - the FMI-based co-simulation environment for Python',
+      author = 'Open Source Modelica Consortium (OSMC)',
+      author_email = 'openmodelicadevelopers@ida.liu.se',
+      license = "BSD, OSMC-PL 1.2, GPL (user's choice)",
+      url = 'http://openmodelica.org/',
+      install_requires = ['requests'],
+      packages = ['OMSimulator'],
+      cmdclass = {'build_py': my_build_py},
+      zip_safe = False
+      )