openflow: simplified/imrpoved configure

Author: rodrigomelo9

examples/configure/Makefile

@@ -0,0 +1,8 @@
+EXAMPLES=$(wildcard *.py)
+
+.PHONY: $(EXAMPLES)
+
+all: $(EXAMPLES)
+
+$(EXAMPLES):
+	python3 $@

examples/configure/file.py

@@ -2,7 +2,7 @@
 
 from openflow.configure import ConfigureTools
 
-cfg = ConfigureTools('../openflow.yml')
+cfg = ConfigureTools('file.yml')
 
 for tool in cfg.get_tools():
     print(cfg.get_command(tool))

examples/configure/file.yml

@@ -0,0 +1,11 @@
+engine: example
+volumes:
+  - "path1:path2"
+  - "path3:path4"
+work: .
+containers:
+  example1: hdlc/example1
+  example2: extra-oci-options hdlc/example2
+names:
+  example1: alt-example1
+  example2: alt-example2

openflow/configure.py

@@ -22,40 +22,26 @@
 """
 
 
+import os
 from yaml import safe_load, dump
 
 
-_DEFAULTS = {
-    'ecppack': 'hdlc/prjtrellis',
-    'ghdl': 'hdlc/ghdl:yosys',
-    'icepack': 'hdlc/icestorm',
-    'iceprog': '--device /dev/bus/usb hdlc/icestorm',
-    'icetime': 'hdlc/icestorm',
-    'nextpnr-ecp5': 'hdlc/nextpnr:ecp5',
-    'nextpnr-ice40': 'hdlc/nextpnr:ice40',
-    'openocd': '--device /dev/bus/usb hdlc/prog',
-    'yosys': 'hdlc/ghdl:yosys',
-}
-
-
 class ConfigureTools:
     """Configure Tools."""
 
-    def __init__(self, filename=None):
+    def __init__(self, filename='.openflow.yml'):
         """Class constructor."""
-        self.configs = {}
-        if filename is not None:
-            with open(filename, 'r') as file:
-                self.configs = safe_load(file)
+        usrfile = os.path.join(os.path.expanduser('~'), filename)
+        prjfile = os.path.join(os.path.dirname(__file__), 'configure.yml')
+        if os.path.exists(filename):
+            filepath = filename
+        elif os.path.exists(usrfile):
+            filepath = usrfile
         else:
-            self.configs['engine'] = 'docker'
-            self.configs['volumes'] = ['$HOME:$HOME']
-            self.configs['work'] = '$PWD'
-            self.configs['containers'] = {}
-            self.configs['names'] = {}
-            for key, value in _DEFAULTS.items():
-                self.configs['containers'][key] = value
-                self.configs['names'][key] = key
+            filepath = prjfile
+        self.configs = {}
+        with open(filepath, 'r') as file:
+            self.configs = safe_load(file)
 
     def get_command(self, tool):
         """Get the command-line needed to run a tool."""

examples/openflow.yml renamed to openflow/configure.yml

@@ -16,6 +16,7 @@
     license='GPLv3',
     url='https://github.com/PyFPGA/openflow',
     packages=find_packages(),
+    package_data={'': ['configure.yml']},
     entry_points={
         'console_scripts': [
             'openflow_syn = openflow.helpers.synthesis:main',
@@ -38,5 +39,6 @@
         'Topic :: Software Development :: Build Tools',
         "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)"
     ],
-    install_requires=['pyyaml']
+    install_requires=['pyyaml'],
+    python_requires=">=3.5, <4"
 )