getting cleaned up for 0.0.1 release

ChangeLog.md

@@ -0,0 +1,5 @@
+# ChangeLog
+
+## 0.0.1
+- Initial release with support for simple templates
+

bin/vte

@@ -0,0 +1,32 @@
+#!/bin/bash
+#****************************************************************************
+#* vte launcher
+#****************************************************************************
+
+# First, determine the location of this script
+if test -f $0; then
+  script_dir=$(dirname $0)
+  script_dir=$(cd $script_dir ; pwd)
+else
+  # Find ourselves in the PATH
+  for elem in $(echo PATH | sed -e 's%:% %g'); do
+    script=${elem}/$0
+    if test -f $script; then
+      script_dir=$elem
+      break
+    fi
+  done
+fi
+
+vte_dir=$(dirname ${script_dir})
+# Need to adjust PYTHONPATH to find dependencies
+export PYTHONPATH=${vte_dir}/lib:$PYTHONPATH
+
+# This is a development area
+if test -d ${vte_dir}/src; then
+  export PYTHONPATH=${vte_dir}/src:$PYTHONPATH
+fi
+
+python3 -m vte ${@:1}
+
+

scripts/ivpm.mk

@@ -8,6 +8,7 @@ BUILD_DIR := $(ROOT_DIR)/build
 BUILD_DEPS += $(BUILD_DIR)/pyyaml.d
 BUILD_DEPS += $(BUILD_DIR)/jinja2.d
 BUILD_DEPS += $(BUILD_DIR)/markupsafe.d
+EDAPACK_BUILD_URL=https://github.com/EDAPack/edapack-build
 
 -include $(PACKAGES_DIR)/packages.mk
 include $(ROOT_DIR)/etc/ivpm.info
@@ -27,6 +28,8 @@ MARKUPSAFE_DIR=markupsafe-$(MARKUPSAFE_VERSION)
 MARKUPSAFE_TGZ=$(BUILD_DIR)/$(MARKUPSAFE_DIR).tar.gz
 MARKUPSAFE_URL=https://github.com/pallets/markupsafe/archive/$(MARKUPSAFE_VERSION).tar.gz
 
+PACKAGE=$(BUILD_DIR)/vte-$(version).tar.gz
+
 RULES := 1
 
 ifeq (true,$(PHASE2))
@@ -79,8 +82,13 @@ $(MARKUPSAFE_TGZ) :
 	$(Q)if test ! -d `dirname $@`; then mkdir -p `dirname $@`; fi
 	$(Q)wget -O $@ $(MARKUPSAFE_URL)
 
-release :
-	echo "TODO: release"
-	exit 1
+release : $(PACKAGE) $(PACKAGES_DIR)/upload.py
+	$(Q)python3 $(PACKAGES_DIR)/upload.py \
+		--user mballance --repo vte \
+		--key $(GITHUB_API_TOKEN) --version $(version) $(PACKAGE)
+
+$(PACKAGES_DIR)/upload.py :
+	$(Q)mkdir -p $(PACKAGES_DIR)
+	$(Q)$(WGET) -O $@ $(EDAPACK_BUILD_URL)/raw/master/scripts/upload.py
 
 -include $(PACKAGES_DIR)/packages.mk

setup.py

@@ -0,0 +1,27 @@
+
+import os
+from setuptools import setup
+
+setup(
+  name = "vte",
+  packages=['vte'],
+  package_dir = {'vte' : 'src/vte'},
+  author = "Matthew Ballance",
+  author_email = "[email protected]",
+  description = ("VTE is a Verification Template Engine for generating content for verification environments from template files and parameters."),
+  license = "Apache 2.0",
+  keywords = ["SystemVerilog", "Verilog", "RTL", "GoogleTest"],
+  url = "https://github.com/mballance/vte",
+  entry_points={
+    'console_scripts': [
+      'vte = vte.__main__:main'
+    ]
+  },
+  setup_requires=[
+    'setuptools_scm',
+  ],
+  install_requires=[
+    'jinja2>=2.10'
+  ],
+)
+

src/vte/__main__.py

@@ -32,6 +32,19 @@ def substitute(vars, str):
 
     return str
 
+def list_templates(args, rgy):
+    print("list_templates")
+    template_ids = sorted(rgy.template_map.keys())
+
+    max_len = 0
+    for id in template_ids:
+      if len(id) > max_len:
+        max_len = len(id)
+
+    fmt_str = "%-" + str(max_len) + "s - %s"
+    for id in template_ids:
+      print(fmt_str % (id, rgy.template_map[id].desc))
+
 def generate(args, parameters, rgy):
     if args.template not in rgy.template_map.keys():
         print("Error: template does not exist")
@@ -140,21 +153,12 @@ def main():
              metavar="KEY=VALUE", 
              nargs="*",
              help="Specify other template variables")
+
+    list_cmd = subparser.add_parser("list",
+        help="list available templates")
 
     args = parser.parse_args()
 
-    if args.name.find("=") != -1:
-        print("Error: name contains '='")
-        exit(1)
-
-    # Check that parameters are properly-specified 
-    parameters = {}
-    for param in args.parameters:
-        idx = param.find("=")
-        if idx == -1:
-            print("Error: parameter specification \"" + param + "\" doesn't contain '='");
-            exit(1)
-        parameters[param[:idx]] = param[idx+1:]
 
     template_path = []
     template_path.append("/project/fun/vte/vte-mballance/templates")
@@ -167,7 +171,24 @@ def main():
     rgy = template_rgy.TemplateRgy(template_path)
 
     if args.subcmd == "generate":
+        if args.name.find("=") != -1:
+            print("Error: name contains '='")
+            exit(1)
+
+        # Check that parameters are properly-specified 
+        parameters = {}
+        for param in args.parameters:
+            idx = param.find("=")
+            if idx == -1:
+                print("Error: parameter specification \"" + param + "\" doesn't contain '='");
+                exit(1)
+            parameters[param[:idx]] = param[idx+1:]
+
         generate(args, parameters, rgy)
+    elif args.subcmd == "list":
+        list_templates(args, rgy)
+    else:
+        exit(1);
 
 
 if __name__ == "__main__":

src/vte/template_engine.py

@@ -12,4 +12,4 @@ def __init__(self, outdir, template):
         self.env = Environment(loader=templLoader)
 
     def generate(self):
-        print "Generate"
+        print("Generate")

src/vte/template_rgy.py

@@ -23,6 +23,7 @@ def __init__(self,
         self.tmpl_id = tmpl_id
         self.tmpl_dir = os.path.dirname(vte_file)
         self.parameters = {}
+        self.desc = ""
 
         vte = configparser.ConfigParser()
         vte.read(vte_file)
@@ -49,6 +50,11 @@ def __init__(self,
 
                 param = Parameter(pname, desc, has_default, default_val)
                 self.parameters[pname] = param
+            elif s == "template":
+              if "desc" in vte[s].keys():
+                self.desc = vte[s]["desc"];
+            else:
+              print("Warning: unhandled section \"" + s + "\" in template " + self.tmpl_id)
 
     def list_templates(self):
         templates = []

src/vte/vte.py

@@ -3,16 +3,9 @@
 #*
 #****************************************************************************
 import sys
-import yaml
-
-class VTETemplate(yaml.YAMLObject):
-    yaml_tag = u'!VTETemplate'
-
-    def __init__(self, name):
-        self.name = name
 
 def vte_main(vte_dir, argv):
-    print "Hello from vte_main"
+    print("Hello from vte_main")
 
 if __name__ == "main":
-    vte_main("foo", sys.argv)
+    vte_main("foo", sys.argv)

templates/ivpm/project/.vte

@@ -0,0 +1,8 @@
+#********************************************************************
+#* ivpm.project
+#*
+#* Creates a template project for a new IVPM project
+#********************************************************************
+
+[template]
+