From cc7b2bb9aab7712bf5f7b8e48a38927cec6eacd9 Mon Sep 17 00:00:00 2001
From: Benjamin Dauvergne <bdauvergne@entrouvert.com>
Date: Mon, 20 Dec 2021 16:58:54 +0100
Subject: [PATCH] add raw and Debian python packaging (#59578)

---
 .gitignore                   |   1 +
 MANIFEST.in                  |   4 ++
 Makefile                     |   1 +
 debian/control               |  14 ++++-
 debian/libjs-godo.install    |   2 +-
 debian/rules                 |  14 +----
 setup.py                     | 109 +++++++++++++++++++++++++++++++++++
 xstatic/__init__.py          |   1 +
 xstatic/pkg/__init__.py      |   1 +
 xstatic/pkg/godo/__init__.py |  40 +++++++++++++
 10 files changed, 174 insertions(+), 13 deletions(-)
 create mode 100644 MANIFEST.in
 create mode 100755 setup.py
 create mode 100644 xstatic/__init__.py
 create mode 100644 xstatic/pkg/__init__.py
 create mode 100644 xstatic/pkg/godo/__init__.py

diff --git a/.gitignore b/.gitignore
index 0e4344e..d8bc208 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
 dist/js/
+dist/*.gz
 node_modules/
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..29e22e0
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,4 @@
+recursive-include xstatic/pkg/godo/data *.css *.js *.map
+include MANIFEST.in
+include MANIFEST
+include README.md
diff --git a/Makefile b/Makefile
index 3727135..adaff2c 100644
--- a/Makefile
+++ b/Makefile
@@ -8,6 +8,7 @@ DIST_FILES = dist/js/godo.js dist/js/godo.min.js dist/css/godo.css dist/js/godo.
 
 clean:
 	rm -rf sdist
+	rm -rf xstatic/pkg/godo/data
 
 build:
 	npm install
diff --git a/debian/control b/debian/control
index d0b14d6..07febd7 100644
--- a/debian/control
+++ b/debian/control
@@ -2,7 +2,7 @@ Source: godo.js
 Maintainer: Benjamin Dauvergne <bdauvergne@entrouvert.com>
 Section: javascript
 Priority: optional
-Build-Depends: debhelper-compat (= 12)
+Build-Depends: debhelper-compat (= 12), dh-python, python3-setuptools, python3-all
 Standards-Version: 4.5.1
 Vcs-Browser: https://git.entrouvert.org/godo.js
 Vcs-Git: https://git.entrouvert.org/godo.js
@@ -15,3 +15,15 @@ Depends: ${misc:Depends}
 Recommends: javascript-common
 Multi-Arch: foreign
 Description: Wysiwyg HTML widget
+
+Package: python3-xstatic-godo
+Architecture: all
+Depends: ${misc:Depends}, ${python3:Depends}, libjs-godo
+Description: godo packaging for Python (Python 3 module)
+ godo javascript library packaged for setuptools (easy_install) / pip.
+ .
+ This package is intended to be used by **any** project that needs these files.
+ .
+ It intentionally does **not** provide any extra code except some metadata
+ **nor** has any extra requirements. You MAY use some minimal support code from
+ the XStatic base package, if you like.
diff --git a/debian/libjs-godo.install b/debian/libjs-godo.install
index 5a53708..e067d37 100644
--- a/debian/libjs-godo.install
+++ b/debian/libjs-godo.install
@@ -1 +1 @@
-godo.* usr/share/javascript/godo/
+xstatic/pkg/godo/data/* usr/share/javascript/godo/
diff --git a/debian/rules b/debian/rules
index 0c9b94c..f562968 100755
--- a/debian/rules
+++ b/debian/rules
@@ -1,15 +1,7 @@
 #!/usr/bin/make -f
 # -*- makefile -*-
-
+#
+export PYBUILD_NAME=xstatic-godo
 
 %:
-	dh $@
-
-#override_dh_auto_build:
-#	mkdir dist
-#	cp index.js dist/index.js
-#	patch -p1 <debian/es5-hook.diff
-#	NODE_PATH=debian/node_modules rollup -c debian/rollup.config.js
-#	rm -f dist/index.js
-#	uglifyjs.terser -o dist/psl.min.js dist/psl.js
-#	dh_auto_build
+	dh $@ --with python3 --buildsystem=pybuild
diff --git a/setup.py b/setup.py
new file mode 100755
index 0000000..f9d5542
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,109 @@
+#! /usr/bin/env python3
+
+import os.path
+import shutil
+import subprocess
+
+from distutils.cmd import Command
+from distutils.command.build import build as _build
+from distutils.command.sdist import sdist as _sdist
+from setuptools import setup, find_packages
+from xstatic.pkg import godo as xs
+
+
+def get_version():
+    """Use the VERSION, if absent generates a version with git describe, if not
+    tag exists, take 0.0- and add the length of the commit log.
+    """
+    if os.path.exists('VERSION'):
+        with open('VERSION') as v:
+            return v.read()
+    if os.path.exists('.git'):
+        p = subprocess.Popen(
+            ['git', 'describe', '--dirty=.dirty', '--match=v*'],
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+        )
+        result = p.communicate()[0]
+        if p.returncode == 0:
+            result = result.decode('ascii').strip()[1:]  # strip spaces/newlines and initial v
+            if '-' in result:  # not a tagged version
+                real_number, commit_count, commit_hash = result.split('-', 2)
+                version = '%s.post%s+%s' % (real_number, commit_count, commit_hash)
+            else:
+                version = result
+            return version
+        else:
+            return '0.0.post%s' % len(subprocess.check_output(['git', 'rev-list', 'HEAD']).splitlines())
+    return '0.0'
+
+
+class compile_nodejs(Command):
+    description = 'compile scss files into css files'
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        if os.path.exists('dist/css'):
+            subprocess.check_call('npm install', shell=True)
+            subprocess.check_call('npm run build', shell=True)
+            if os.path.exists('xstatic/pkg/godo/data'):
+                shutil.rmtree('xstatic/pkg/godo/data')
+            shutil.copytree('dist', 'xstatic/pkg/godo/data/', ignore=shutil.ignore_patterns('*.gz'))
+
+
+class build(_build):
+    sub_commands = [('compile_nodejs', None)] + _build.sub_commands
+
+
+class sdist(_sdist):
+    sub_commands = [('compile_nodejs', None)] + _sdist.sub_commands
+
+    def run(self):
+        print("creating VERSION file")
+        if os.path.exists('VERSION'):
+            os.remove('VERSION')
+        version = get_version()
+        version_file = open('VERSION', 'w')
+        version_file.write(version)
+        version_file.close()
+        _sdist.run(self)
+        print("removing VERSION file")
+        if os.path.exists('VERSION'):
+            os.remove('VERSION')
+
+
+setup(
+    name=xs.PACKAGE_NAME,
+    version=get_version(),
+    description=xs.DESCRIPTION,
+    classifiers=xs.CLASSIFIERS,
+    keywords=xs.KEYWORDS,
+    maintainer=xs.MAINTAINER,
+    maintainer_email=xs.MAINTAINER_EMAIL,
+    license=xs.LICENSE,
+    url=xs.HOMEPAGE,
+    platforms=xs.PLATFORMS,
+    packages=find_packages(),
+    namespace_packages=[
+        'xstatic',
+        'xstatic.pkg',
+    ],
+    include_package_data=True,
+    package_data={
+        'xstatic.pkg.godo': ['data/*'],
+    },
+    zip_safe=False,
+    install_requires=[],  # nothing! :)
+    # if you like, you MAY use the 'XStatic' package.
+    cmdclass={
+        'build': build,
+        'sdist': sdist,
+        'compile_nodejs': compile_nodejs,
+    },
+)
diff --git a/xstatic/__init__.py b/xstatic/__init__.py
new file mode 100644
index 0000000..de40ea7
--- /dev/null
+++ b/xstatic/__init__.py
@@ -0,0 +1 @@
+__import__('pkg_resources').declare_namespace(__name__)
diff --git a/xstatic/pkg/__init__.py b/xstatic/pkg/__init__.py
new file mode 100644
index 0000000..de40ea7
--- /dev/null
+++ b/xstatic/pkg/__init__.py
@@ -0,0 +1 @@
+__import__('pkg_resources').declare_namespace(__name__)
diff --git a/xstatic/pkg/godo/__init__.py b/xstatic/pkg/godo/__init__.py
new file mode 100644
index 0000000..4163a09
--- /dev/null
+++ b/xstatic/pkg/godo/__init__.py
@@ -0,0 +1,40 @@
+"""
+XStatic resource package
+
+See package 'XStatic' for documentation and basic tools.
+"""
+
+import os
+
+DISPLAY_NAME = 'godo'  # official name, upper/lowercase allowed, no spaces
+PACKAGE_NAME = 'XStatic-%s' % DISPLAY_NAME  # name used for PyPi
+
+NAME = __name__.split('.')[-1]  # package name (e.g. 'foo' or 'foo_bar')
+# please use a all-lowercase valid python
+# package name
+
+VERSION = '0.2'  # version of the packaged files, please use the upstream
+# version number
+BUILD = '1'  # our package build number, so we can release new builds
+# with fixes for xstatic stuff.
+PACKAGE_VERSION = VERSION + '.' + BUILD  # version used for PyPi
+
+DESCRIPTION = "%s %s (XStatic packaging standard)" % (DISPLAY_NAME, VERSION)
+
+PLATFORMS = 'any'
+CLASSIFIERS = []
+KEYWORDS = '%s xstatic' % NAME
+
+# XStatic-* package maintainer:
+MAINTAINER = 'Benjamin Dauvergne'
+MAINTAINER_EMAIL = 'bdauvergne@entrouvert.com'
+
+# this refers to the project homepage of the stuff we packaged:
+HOMEPAGE = 'http://dev.entrouvert.org/project/godo/'
+
+# this refers to all files:
+LICENSE = '(same as %s)' % DISPLAY_NAME
+
+BASE_DIR = os.path.join(os.path.dirname(__file__), 'data')
+
+LOCATIONS = {}