Errors when running specsetup.py via make

[falko]

$ make
/home/falko/git/mdsa-omg-spec-test/./mdsa-tools/omgmdsa/specsetup.py:53: SyntaxWarning: invalid escape sequence '\s'
  setup.write("\setvalue\{" + field + "}{" + self.__dict__[field] + "}\n")
Traceback (most recent call last):
  File "/home/falko/git/mdsa-omg-spec-test/./mdsa-tools/omgmdsa/specsetup.py", line 8, in <module>
    from errutils import erlogging
ModuleNotFoundError: No module named 'errutils'
/home/falko/git/mdsa-omg-spec-test/./mdsa-tools/omgmdsa/specsetup.py:53: SyntaxWarning: invalid escape sequence '\s'
  setup.write("\setvalue\{" + field + "}{" + self.__dict__[field] + "}\n")
Traceback (most recent call last):
  File "/home/falko/git/mdsa-omg-spec-test/./mdsa-tools/omgmdsa/specsetup.py", line 8, in <module>
    from errutils import erlogging
ModuleNotFoundError: No module named 'errutils'
mkdir -p "build"
cp mdsa-omg-core/RFP_Template.tex build/RFP_Template.tex
cp mdsa-omg-core/RFP.tex build/RFP.tex
cp mdsa-omg-core/Specification_Template.tex build/Specification_Template.tex
cp mdsa-omg-core/Specification.tex build/Specification.tex
cp mdsa-omg-core/omg_modelgen.sty build/omg_modelgen.sty
cp mdsa-omg-core/omg_rfp.sty build/omg_rfp.sty
cp mdsa-omg-core/omg_specification.sty build/omg_specification.sty
cp mdsa-omg-core/omg.sty build/omg.sty
cp mdsa-omg-core/iso.bib build/iso.bib
cp mdsa-omg-core/omg.bib build/omg.bib
cp mdsa-omg-core/w3.bib build/w3.bib
cp 0_Acknowledgements.tex build/0_Acknowledgements.tex
cp 0_Additional.tex build/0_Additional.tex
cp 0_Changes_To_Existing.tex build/0_Changes_To_Existing.tex
cp 0_Introduction.tex build/0_Introduction.tex
cp 0_Issues.tex build/0_Issues.tex
cp 0_Proof_Of_Concept.tex build/0_Proof_Of_Concept.tex
cp 0_Relation_To_Existing.tex build/0_Relation_To_Existing.tex
cp 0_Resolutions_Mandatory.tex build/0_Resolutions_Mandatory.tex
cp 0_Resolutions_Optional.tex build/0_Resolutions_Optional.tex
cp 0_Submitters.tex build/0_Submitters.tex
cp 1_Scope.tex build/1_Scope.tex
cp 2_Basic_Conformance.tex build/2_Basic_Conformance.tex
cp 2_Extended_Conformance.tex build/2_Extended_Conformance.tex
cp 2_Profile_Conformance.tex build/2_Profile_Conformance.tex
cp 4_Terms.tex build/4_Terms.tex
cp 5_Symbols.tex build/5_Symbols.tex
cp 6_Additional.tex build/6_Additional.tex
cp 7+_Technical_Content.tex build/7+_Technical_Content.tex
cp A_Annexes.tex build/A_Annexes.tex
cp _Specification_AuthorSettings.tex build/_Specification_AuthorSettings.tex
cp _Specification_Setup.tex build/_Specification_Setup.tex
cp specification.bib build/specification.bib
--- Creating PDF
cd build && pdflatex ./Specification.tex 2>&1 > /dev/null

I already found that errutils is a Python library but I don't know how to install it.

[falko]

make seems to hang and pdflatex just stays running forever. I have to kill make from outside.

[jasonmccsmith]

The errutils issue is due to mdsa-tools getting cloned, but not installed. Until that is handled by make, cd mdsa-tools; python setup.py install will take care of it so you can get going.

The pdflatex hang can be cancelled gracefully with a Ctrl-D, but it's due to pdflatex reporting an error (eaten by /dev/null) and waiting for input.

Possible fix for user confusion: stop sending error messages to /dev/null

Remove 2>&1 > /dev/null in Makefile and test again to see what error is. Given the errutils issue, I'm 99% sure it's silently hanging on calling specsetup.py. The above install should resolve that.

[falko]

I tried sudo python setup.py install and got the following output:

[sudo] password for falko: 
running install
/usr/lib/python3/dist-packages/setuptools/_distutils/cmd.py:66: SetuptoolsDeprecationWarning: setup.py install is deprecated.
!!

        ********************************************************************************
        Please avoid running ``setup.py`` directly.
        Instead, use pypa/build, pypa/installer or other
        standards-based tools.

        See https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html for details.
        ********************************************************************************

!!
  self.initialize_options()
/usr/lib/python3/dist-packages/setuptools/_distutils/cmd.py:66: EasyInstallDeprecationWarning: easy_install command is deprecated.
!!

        ********************************************************************************
        Please avoid running ``setup.py`` and ``easy_install``.
        Instead, use pypa/build, pypa/installer or other
        standards-based tools.

        See https://github.com/pypa/setuptools/issues/917 for details.
        ********************************************************************************

!!
  self.initialize_options()
running bdist_egg
running egg_info
creating omgmdsa.egg-info
writing omgmdsa.egg-info/PKG-INFO
writing dependency_links to omgmdsa.egg-info/dependency_links.txt
writing entry points to omgmdsa.egg-info/entry_points.txt
writing requirements to omgmdsa.egg-info/requires.txt
writing top-level names to omgmdsa.egg-info/top_level.txt
writing manifest file 'omgmdsa.egg-info/SOURCES.txt'
reading manifest file 'omgmdsa.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
adding license file 'LICENSE'
writing manifest file 'omgmdsa.egg-info/SOURCES.txt'
installing library code to build/bdist.linux-x86_64/egg
running install_lib
warning: install_lib: 'build/lib' does not exist -- no Python modules to install

creating build
creating build/bdist.linux-x86_64
creating build/bdist.linux-x86_64/egg
creating build/bdist.linux-x86_64/egg/EGG-INFO
copying omgmdsa.egg-info/PKG-INFO -> build/bdist.linux-x86_64/egg/EGG-INFO
copying omgmdsa.egg-info/SOURCES.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
copying omgmdsa.egg-info/dependency_links.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
copying omgmdsa.egg-info/entry_points.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
copying omgmdsa.egg-info/not-zip-safe -> build/bdist.linux-x86_64/egg/EGG-INFO
copying omgmdsa.egg-info/requires.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
copying omgmdsa.egg-info/top_level.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
creating dist
creating 'dist/omgmdsa-0.1-py3.12.egg' and adding 'build/bdist.linux-x86_64/egg' to it
removing 'build/bdist.linux-x86_64/egg' (and everything under it)
Processing omgmdsa-0.1-py3.12.egg
creating /usr/local/lib/python3.12/dist-packages/omgmdsa-0.1-py3.12.egg
Extracting omgmdsa-0.1-py3.12.egg to /usr/local/lib/python3.12/dist-packages
Adding omgmdsa 0.1 to easy-install.pth file
Installing makechangebartex script to /usr/local/bin
Installing md2latex script to /usr/local/bin

Installed /usr/local/lib/python3.12/dist-packages/omgmdsa-0.1-py3.12.egg
Processing dependencies for omgmdsa==0.1
Searching for errutils@ git+https://github.com/jasonmccsmith/errutils.git
Reading https://pypi.org/simple/errutils/
Couldn't find index page for 'errutils' (maybe misspelled?)
Scanning index of all packages (this may take a while)
Reading https://pypi.org/simple/
No local packages or working download links found for errutils@ git+https://github.com/jasonmccsmith/errutils.git
error: Could not find suitable distribution for Requirement.parse('errutils@ git+https://github.com/jasonmccsmith/errutils.git')

I'm not sure this is the right approach because my Python environment is managed by APT (I'm on Ubuntu 24.04.2 LTS). I'll try a virtual Python environment...

[jasonmccsmith]

Errutils was created a few years ago. I obviously haven't kept up with the latest python packaging fads. :P thanks, will address.

In the meantime, you can comment out lines 8-11 in mdsa-tools/omgmdsa/specsetup.py to bypass the problem.

The errutils issue will need to be resolved before changebar management can be done, but specsetup.py no longer uses that package.

[falko]

A Python virtual environment seems to work:

python3 -m venv venv
source venv/bin/activate
pip install setuptools
python setup.py install

For some reason this still does not seem to install errorutils:

running install
/home/falko/git/mdsa-omg-spec-test/venv/lib/python3.12/site-packages/setuptools/_distutils/cmd.py:90: SetuptoolsDeprecationWarning: setup.py install is deprecated.
!!

        ********************************************************************************
        Please avoid running ``setup.py`` directly.
        Instead, use pypa/build, pypa/installer or other
        standards-based tools.

        By 2025-Oct-31, you need to update your project and remove deprecated calls
        or your builds will no longer be supported.

        See https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html for details.
        ********************************************************************************

!!
  self.initialize_options()
running build
running install_egg_info
running egg_info
creating omgmdsa.egg-info
writing omgmdsa.egg-info/PKG-INFO
writing dependency_links to omgmdsa.egg-info/dependency_links.txt
writing entry points to omgmdsa.egg-info/entry_points.txt
writing requirements to omgmdsa.egg-info/requires.txt
writing top-level names to omgmdsa.egg-info/top_level.txt
writing manifest file 'omgmdsa.egg-info/SOURCES.txt'
reading manifest file 'omgmdsa.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
adding license file 'LICENSE'
writing manifest file 'omgmdsa.egg-info/SOURCES.txt'
Copying omgmdsa.egg-info to /home/falko/git/mdsa-omg-spec-test/venv/lib/python3.12/site-packages/omgmdsa-0.1-py3.12.egg-info
running install_scripts
Installing makechangebartex script to /home/falko/git/mdsa-omg-spec-test/venv/bin
Installing md2latex script to /home/falko/git/mdsa-omg-spec-test/venv/bin

So I ran pip install click git+https://github.com/jasonmccsmith/errutils.git manually afterwards and then make looks better but still gets stuck:

/home/falko/git/mdsa-omg-spec-test/./mdsa-tools/omgmdsa/specsetup.py:53: SyntaxWarning: invalid escape sequence '\s'
  setup.write("\setvalue\{" + field + "}{" + self.__dict__[field] + "}\n")
/home/falko/git/mdsa-omg-spec-test/./mdsa-tools/omgmdsa/specsetup.py:53: SyntaxWarning: invalid escape sequence '\s'
  setup.write("\setvalue\{" + field + "}{" + self.__dict__[field] + "}\n")
--- Creating PDF
cd build && pdflatex ./Specification.tex 2>&1 > /dev/null

After removing 2>&1 > /dev/null from the Makefile, I'm seeing LaTeX errors: Specification.log

When hitting enter on all of them, there is already a PDF in ./build/Specification.pdf but I guess, I am missing LaTeX packages?

[jasonmccsmith]

Indeed, it appears the first error encountered is:

! LaTeX Error: File `biblatex.sty' not found.

That would definitely cause it to fail.

What bib system do you normally use?

[jasonmccsmith]

errutils updated to use pyproject.toml install instead of setup.py.

[jasonmccsmith]

Tracking backslashes in: ObjectManagementGroup/mdsa-tools#4 (Closed)

[falko]

I don't normally use LaTeX. I have TeX Live installed on Ubuntu and was able to fix this error using:

sudo apt install texlive-bibtex-extra

I still get different output than you, which I have to investigate further.

[jasonmccsmith]

make debug now shows the output from LaTeX processing for debugging purposes. ( ObjectManagementGroup/mdsa-omg-core#2 )

[falko]

That is a great improvement but I don't have an easy way to pull upstream changes from the template into my repository because I don't have a fork. I'm tempted to try forking even though this may create merge conflicts with the content files. Git should be able to cleanly merge improvements to the specification setup and the Makefile.

Alternatively, we could work with an include in the Makefile to move it's actual contents into mdsa-tools.

[jasonmccsmith]

That’s actually how it’s set up… the Makefike includes mdsa-omg-core/_core.mk where the logic is. That can be updated independently of the author space. (It's in core, instead of tools, because it places the Makefile with the pieces it's building from. Either works, that was just the decision I made to allow for quick building during testing of the core.) ‘git pull —recurse’ at top level should grab the updates. When a submodule is updated you’ll see it appear in the main repo status list to be added and committed. It’s committing the new commit id for the submodule.  I’ve been shoving the logic down into core as much as possible for exactly this reason. At some point we'll have the top level repo stripped of anything meaningful as far as build, and it will defer to the updatable mdsa-omg-core for behavior. Right now the remaining bits in Makefile are the top level driver, a couple of user-settable folder locations and two variables that I want to move down into _core.mk.