issue2551167 roundup issues when using pip install

Running pip install generates a wheel install. This places locale,
template and man pages under site-packages/usr/share/....

These changes make roundup look there for templates (affecting
admin.py) and locale (affecting i18n.py) files.  This also makes it
work better in virtual environment and containers (docker).

There is also a commented out bit of code in setup.py that prevents it
from making a bdist_wheel forcing a regular install with files put
under /usr/locale etc. This can be re-enabled if needed for 2.2 if
there are still issues with roundup that aren't solved by then.

Author: rouilj

CHANGES.txt

@@ -35,6 +35,9 @@ Fixed:
   length. All other paths with a . in then will be passed through
   without change. This allows items like a JWT to be passed as a path
   element. (John Rouillard)
+- issue2551167 - pip install in containerized environments puts
+  template and locale files under site-packages where roundup can't find
+  them. Change code to find them under site-packages.
 
 Features:
 

roundup/admin.py

@@ -324,6 +324,21 @@ def listTemplates(self):
                 templates = init.listTemplates(tdir)
                 break
 
+        # search for data files parallel to the roundup
+        # install dir. E.G. a wheel install
+        #  use roundup.__path__ and go up a level then use sys.prefix
+        #  to create a base path for searching.
+
+        import roundup, sys
+        # roundup.__path__ should be something like:
+        #    /usr/local/lib/python3.10/site-packages/roundup
+        # os.prefix should be /usr, /usr/local or root of virtualenv
+        #    strip leading / to make os.path.join work right.
+        tdir = os.path.join(os.path.dirname(roundup.__path__[0]),
+                            sys.prefix[1:], 'share', 'roundup', 'templates')
+        if os.path.isdir(tdir):
+            templates.update(init.listTemplates(tdir))
+            
         # OK, now try as if we're in the roundup source distribution
         # directory, so this module will be in .../roundup-*/roundup/admin.py
         # and we're interested in the .../roundup-*/ part.

roundup/i18n.py

@@ -58,6 +58,19 @@
     LOCALE_DIRS.append(_mo_path)
 del _mo_path
 
+# find path when locale files are installed as part of a wheel
+# roundup.__path__ should be something like:
+#    /usr/local/lib/python3.10/site-packages/roundup
+# os.prefix should be /usr, /usr/local or root of virtualenv
+#    strip leading / to make os.path.join work right.
+import roundup, sys
+_ldir = os.path.join(
+    os.path.dirname(roundup.__path__[0]),
+    sys.prefix[1:], 'share', 'locale')
+if os.path.isdir(_ldir):
+    LOCALE_DIRS.append(_ldir)
+del _ldir
+
 # Roundup text domain
 DOMAIN = "roundup"
 

setup.py

@@ -216,6 +216,16 @@ def main():
           data_files=data_files)
 
 if __name__ == '__main__':
+
+    # Prevent `pip install roundup` from building bdist_wheel.
+    # Man pages, templates, locales installed under site-packages not
+    #  in normal system locations.
+    # https://stackoverflow.com/questions/36846260/can-python-setuptools-install-files-outside-dist-packages
+    '''
+    if 'bdist_wheel' in sys.argv:
+        raise RuntimeError("This setup.py does not support wheels")
+    '''
+
     os.chdir(os.path.dirname(__file__) or '.')
     main()