Merge branch '15-update-pywrtd-packaging-versioning-links-to-documentation-etc' into 'master'

Resolve "Update PyWrtd packaging, versioning, links to documentation, etc."

Closes #15 and #13

See merge request be-cem-edl/chronos/wrtd!10

.gitlab-ci.yml

@@ -10,17 +10,9 @@ variables:
 include:
   - project: 'be-cem-edl/evergreen/gitlab-ci'
     ref: master
-    file:
-      - 'edl-gitlab-ci.yml'
+    file: 'edl-gitlab-ci.yml'
 
-build-centos-7:
-  interruptible: true
-  stage: build
-  image:
-    name: gitlab-registry.cern.ch/be-cem-edl/evergreen/gitlab-ci/build-fec-sw:latest
-  script:
-    - make -C software
-  artifacts:
-    paths:
-      - include/
-      - software/lib/
+software_build:
+  extends: .build_fec_os_sw
+  variables:
+    EDL_CI_SW_PATHS: $CI_PROJECT_DIR/software

mock-turtle @ 65d4ea0c

-Subproject commit 1f399c96dafafbe124540266b4b155d051c42dec
+Subproject commit 65d4ea0cca3b09f8150cd4378318bd1f3c5b1834

software/Makefile

@@ -14,10 +14,12 @@ REPO_PARENT ?= $(CURDIR)/..
 # on Mock Turtle.
 WRTD_DEP_TRTL ?= $(CURDIR)/../dependencies/mock-turtle
 
-DIRS = $(WRTD_DEP_TRTL)/software lib lib/python tools
+DIRS = lib lib/python tools
 
 all clean install: $(DIRS)
 
+lib: libmockturtle
+
 tools: lib
 
 .PHONY: all clean install $(DIRS)
@@ -27,3 +29,6 @@ install: TARGET = install
 
 $(DIRS):
 	$(MAKE) -C $@ $(TARGET)
+
+libmockturtle:
+	$(MAKE) -C $(WRTD_DEP_TRTL)/software/lib

software/lib/Makefile

@@ -12,20 +12,28 @@
 REPO_PARENT ?= ..
 -include $(REPO_PARENT)/parent_common.mk
 
-GIT_VERSION    := $(shell git describe --always --dirty --long --tags)
-SO_VERSION_XYZ := $(shell git describe --tags --abbrev=0 | grep -o -E "[0-9]+\.[0-9]+\.[0-9]")
+GIT_VERSION ?= $(shell git describe --dirty --long --tags --always | tr -d "v")
+VER_MAJOR=$(word 1,$(subst ., ,$(GIT_VERSION)))
+VER_MINOR=$(word 2,$(subst ., ,$(GIT_VERSION)))
+VER_PATCH=$(word 1,$(subst -, ,$(word 3,$(subst ., ,$(GIT_VERSION)))))
 
-ifeq ($(SO_VERSION_XYZ),)
-	SO_VERSION_XYZ := 0
+SO_VERSION_XYZ=$(VER_MAJOR).$(VER_MINOR).$(VER_PATCH)
+SO_VERSION_X=$(VER_MAJOR)
+
+ifeq ($(SO_VERSION_X),)
+	SO_VERSION_X := 0
 endif
 
-PREFIX ?= /usr/local
-DESTLIBDIR ?= $(PREFIX)/lib
+DESTDIR ?=
+prefix ?= /usr/local
+libdir ?= $(prefix)/lib
+includedir ?= $(prefix)/include
 
 WRTD_DEP_TRTL ?= ../../dependencies/mock-turtle/
 
 LIBSO     = libwrtd.so
 LIBSO_XYZ = $(LIBSO).$(SO_VERSION_XYZ)
+LIBSO_X   = $(LIBSO).$(SO_VERSION_X)
 LIB       = libwrtd.a
 OBJS     := libwrtd.o libwrtd-internal.o libwrtd-attributes.o libwrtd-reconfigure.o
 
@@ -38,30 +46,31 @@ CFLAGS += -DVERSION="\"$(GIT_VERSION)\""
 CFLAGS += $(EXTRACFLAGS)
 ARFLAGS = rcv
 
-all: $(LIB) $(LIBSO)
+all: $(LIB) $(LIBSO) $(LIBSO_XYZ)
 
 $(LIB): $(OBJS)
 	$(AR) $(ARFLAGS) $@ $^
 
 $(LIBSO_XYZ): $(OBJS)
-	$(CC) -shared $^ -L$(WRTD_DEP_TRTL)/software/lib -lmockturtle -o $@
+	$(CC) -shared $^ -Wl,-soname,$(LIBSO_X) -L$(WRTD_DEP_TRTL)/software/lib -lmockturtle -o $@
 
 $(LIBSO): $(LIBSO_XYZ)
 	ln -sf $< $@
 
 clean:
-	rm -f $(LIB) $(LIBSO) $(LIBSO_XYZ) *.d *.o *~
+	rm -f $(LIB) $(LIBSO) $(LIBSO_XYZ) $(OBJS) *.d *.o *.so* *~
 
 %.o: %.c
 	$(CC) -c $(CFLAGS) -MMD $< -o $@
 
-install: $(LIBSO) $(LIBSO_XYZ)
-	install -d $(DESTLIBDIR)
-	install -m 0755 $(LIBSO_XYZ) $(DESTLIBDIR)
-	ln -sf $(LIBSO_XYZ) $(DESTLIBDIR)/$(LIBSO)
-
-uninstall:
-	rm -f $(DESTLIBDIR)/$(LIBSO) $(DESTLIBDIR)/$(LIBSO_XYZ)
-	rmdir --ignore-fail-on-non-empty $(DESTLIBDIR)
+deploy deploy-libwrtd: install
+install: $(LIBSO) $(LIBSO_XYZ) $(LIB)
+	mkdir -m 0775 -p $(DESTDIR){$(libdir),$(includedir)}
+	install -D -t $(DESTDIR)$(libdir) -m 0755 $(LIBSO_XYZ)
+	install -D -t $(DESTDIR)$(libdir) -m 0644 $(LIB)
+	install -D -t $(DESTDIR)$(includedir) -m 0644 libwrtd.h ../include/wrtd-common.h
+	cp -d $(LIBSO) $(DESTDIR)$(libdir)
 
 -include $(wildcard *.d)
+
+.PHONY: install

software/lib/python/Makefile

@@ -5,8 +5,27 @@
 -include Makefile.specific
 
 all:
+
 clean:
+	rm -rf dist *.egg-info
+
+GIT_VERSION ?= $(shell git describe --dirty --long --tags --always | tr -d "v")
+VER_MAJOR=$(word 1,$(subst ., ,$(GIT_VERSION)))
+VER_MINOR=$(word 2,$(subst ., ,$(GIT_VERSION)))
+VER_PATCH=$(word 1,$(subst -, ,$(word 3,$(subst ., ,$(GIT_VERSION)))))
+VERSION=$(VER_MAJOR).$(VER_MINOR).$(VER_PATCH)
+
+DESTDIR ?=
+prefix ?= /usr/local
+libdir ?= $(prefix)/lib
+
+pythondir ?= $(libdir)/python
+
+deploy deploy-pywrtd: install
 install:
-	python setup.py install
+	mkdir -m 0775 -p $(DESTDIR)$(pythondir)/site-packages
+	install -D -t $(DESTDIR)$(pythondir)/site-packages -m 0644 PyWrtd/PyWrtd.py
+	python -m pip install build
+	VERSION=$(VERSION) python -m build -o $(DESTDIR)$(pythondir)
 
 .PHONY: all clean install

software/lib/python/setup.py

@@ -6,20 +6,22 @@ SPDX-License-Identifier: LGPL-2.1-or-later
 """
 from setuptools import setup, find_packages
 
+import os
+
 setup(
     name='PyWrtd',
-    version='1.0',
+    version=os.environ.get('VERSION', "0.0.0"),
     description='Python wrapper for WRTD',
     author='Milosz Malczak',
     author_email='milosz.malczak@cern.ch',
-    maintainer="Dimitris Lampridis",
-    maintainer_email="dimitris.lampridis@cern.ch",
+    maintainer="Tristan Gingold",
+    maintainer_email="tristan.gingold@cern.ch",
     url='http://www.ohwr.org/projects/wrtd',
     project_urls={
-        "Documentation": "https://wrtd.readthedocs.io",
+        "Documentation": "https://be-cem-edl.web.cern.ch/wrtd/",
         "Forum"        : "https://forums.ohwr.org/c/wrtd",
     },
     install_requires=['decorator'],
     packages=find_packages(),
-    license='LGPLv3',
+    license='LGPLv2.1',
 )

software/tools/Makefile

@@ -5,9 +5,25 @@
 
 -include Makefile.specific
 
+GIT_VERSION ?= $(shell git describe --dirty --long --tags --always | tr -d "v")
+VER_MAJOR=$(word 1,$(subst ., ,$(GIT_VERSION)))
+VER_MINOR=$(word 2,$(subst ., ,$(GIT_VERSION)))
+VER_PATCH=$(word 1,$(subst -, ,$(word 3,$(subst ., ,$(GIT_VERSION)))))
+VERSION=$(VER_MAJOR).$(VER_MINOR).$(VER_PATCH)
+
+DESTDIR ?=
+prefix ?= /usr/local
+exec_prefix ?= $(prefix)
+bindir ?= $(exec_prefix)/bin
+
 all:
+
 clean:
+
+deploy deploy-wrtdtool: install
 install:
-	python setup.py install
+	mkdir -m 0775 -p $(DESTDIR)$(bindir)/wrtd-tool-dir
+	install -D -t $(DESTDIR)$(bindir) -m 0755 wrtd-tool
+	install -D -t $(DESTDIR)$(bindir)/wrtd-tool-dir -m 0755 wrtd_tool/wrtd_tool.py
 
 .PHONY: all clean install

software/tools/setup.py

@@ -4,21 +4,23 @@
 
 from setuptools import setup, find_packages
 
+import os
+
 setup(
     name="wrtd-tool",
-    version="1.0",
+    version=os.environ.get('VERSION', "0.0.0"),
     packages=find_packages(),
     description='WRTD Tool',
     author="Dimitris Lampridis",
     author_email="dimitris.lampridis@cern.ch",
-    maintainer="Dimitris Lampridis",
-    maintainer_email="dimitris.lampridis@cern.ch",
+    maintainer="Tristan Gingold",
+    maintainer_email="tristan.gingold@cern.ch",
     url='http://www.ohwr.org/projects/wrtd',
     project_urls={
-        "Documentation": "https://wrtd.readthedocs.io",
+        "Documentation": "https://be-cem-edl.web.cern.ch/wrtd/",
         "Forum"        : "https://forums.ohwr.org/c/wrtd",
     },
-    license='LGPLv3',
+    license='LGPLv2.1',
     entry_points = {
         'console_scripts': [
             "wrtd-tool = wrtd_tool.wrtd_tool:main"

software/tools/wrtd-tool

+#!/bin/sh
+# SPDX-FileCopyrightText: 2022 CERN (home.cern)
+#
+# SPDX-License-Identifier: LGPL-2.1-or-later
+
+WRTD_TOOL_DIR=$(dirname $(readlink -f $0))/wrtd-tool-dir
+export PYTHONPATH=$(dirname $(readlink -f $0))/../lib/python/site-packages
+WRTD_LIB_DIR=$(dirname $(readlink -f $0))/../lib/
+export LD_LIBRARY_PATH=$WRTD_LIB_DIR:$LD_LIBRARY_PATH
+
+exec "$WRTD_TOOL_DIR/wrtd_tool.py" "$@"