[feat] setup.py for web ui files (#1627)

Author: devfox-se

.github/workflows/python-package.yml

@@ -16,16 +16,58 @@ on:
   workflow_dispatch:
 
 jobs:
+  aim-ui-dist:
+    if: ${{ github.event_name == 'schedule' || github.actor == 'gorarakelyan' || github.actor == 'alberttorosyan' || github.actor == 'roubkar' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ inputs.branch || github.ref }}
+
+      - name: Use node v16
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+
+      - name: Build UI
+        working-directory: ./aim/web/ui
+        run: |
+          npm i
+          CI=false npm run build
+
+      - name: Setup python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+          architecture: x64
+
+      - name: Install dev dependencies
+        run: |
+          python -m pip install -r requirements.dev.txt
+
+      - name: Build sdist
+        working-directory: ./aim/web/ui
+        run: |
+          python setup.py sdist
+
+      - name: Publish wheel
+        env:
+          PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        working-directory: ./aim/web/ui
+        run: |
+          python -m twine upload -u __token__ -p "${PYPI_PASSWORD}" dist/*
+
   linux-dist:
     if: ${{ github.event_name == 'schedule' || github.actor == 'gorarakelyan' || github.actor == 'alberttorosyan' || github.actor == 'roubkar' }}
     runs-on: ubuntu-latest
     name: Linux wheels build (using Docker)
+    needs: aim-ui-dist
     steps:
       - name: Install Docker & pull images
         run: |
           apt update && apt install -y docker.io
           sudo systemctl enable --now docker
-
           docker pull quay.io/pypa/manylinux_2_24_x86_64
 
       - name: Checkout sources
@@ -39,17 +81,6 @@ jobs:
           AIM_VERSION=$(< ./aim/VERSION)
           echo "::set-output name=AIM_VERSION::$AIM_VERSION"
 
-      - name: Use node v16
-        uses: actions/setup-node@v2
-        with:
-          node-version: '16'
-
-      - name: Build UI
-        working-directory: ./aim/web/ui
-        run: |
-          npm i
-          CI=false npm run build
-
       - name: Setup python
         uses: actions/setup-python@v2
         with:
@@ -63,7 +94,7 @@ jobs:
 
       - name: Build bdist wheels
         run: |
-         docker run --mount type=bind,source=$PWD,target=/opt/aim quay.io/pypa/manylinux_2_24_x86_64 bash /opt/aim/docker/build-wheels.sh
+          docker run --mount type=bind,source=$PWD,target=/opt/aim quay.io/pypa/manylinux_2_24_x86_64 bash /opt/aim/docker/build-wheels.sh
 
       - name: Publish wheels
         env:
@@ -93,23 +124,13 @@ jobs:
         python-version: [ '3.6', '3.7', '3.8', '3.9', '3.10' ]
         os: [ 'macos-latest' ]
     name: Python ${{ matrix.python-version }} on ${{ matrix.os }} build
+    needs: aim-ui-dist
     steps:
       - name: Checkout sources
         uses: actions/checkout@v2
         with:
           ref: ${{ inputs.branch || github.ref }}
 
-      - name: Use node v16
-        uses: actions/setup-node@v2
-        with:
-          node-version: '16'
-
-      - name: Build UI
-        working-directory: ./aim/web/ui
-        run: |
-          npm i
-          CI=false npm run build
-
       - name: Setup python
         uses: actions/setup-python@v2
         with:

MANIFEST.in

@@ -2,4 +2,4 @@ include README.md LICENSE aim/VERSION
 recursive-include aim/storage *.h *.hpp *.cpp *.cxx *.pxd *.pyx
 recursive-include aim/storage/migrations *
 recursive-include aim/web/migrations *
-recursive-include aim/web/ui/build *
+

aim/web/ui/VERSION

@@ -0,0 +1 @@
+../../VERSION

aim/web/ui/setup.py

@@ -0,0 +1,37 @@
+import os
+
+from setuptools import setup
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+version_file = os.path.join(here, 'VERSION')
+with open(version_file) as vf:
+    __version__ = vf.read().strip()
+
+# Package meta-data.
+NAME = 'aim-ui'
+DESCRIPTION = 'Aim UI'
+VERSION = __version__
+
+
+def package_files(directory):
+    paths = []
+    for (path, _, filenames) in os.walk(directory):
+        for filename in filenames:
+            paths.append(os.path.join(path, filename))
+    return paths
+
+
+files = package_files('build')
+
+# This is a symlink so main version
+files.append('VERSION')
+
+setup(
+    name=NAME,
+    version=__version__,
+    description=DESCRIPTION,
+    packages=["aim.web.ui"],
+    package_dir={'aim.web.ui': '.'},
+    package_data={'aim.web.ui': files}
+)

requirements.txt

@@ -1,3 +1,4 @@
 # installs dependencies from ./setup.py, and the package itself,
 # in editable mode
+-e ./aim/web/ui
 -e .

setup.py

@@ -1,17 +1,15 @@
 import sys
 import os
-import io
+
 from shutil import rmtree
 from setuptools import find_packages, setup, Command, Extension
 from Cython.Build import cythonize
 
 version_file = 'aim/VERSION'
 
-__version__ = None
 with open(version_file) as vf:
     __version__ = vf.read().strip()
 
-
 here = os.path.abspath(os.path.dirname(__file__))
 
 # Package meta-data.
@@ -33,7 +31,6 @@ def package_files(directory):
     return paths
 
 
-ui_files = package_files('aim/web/ui/build')
 migration_files = package_files('aim/web/migrations')
 storage_migration_files = package_files('aim/storage/migrations')
 version_files = ['../aim/VERSION', ]
@@ -47,6 +44,7 @@ def package_files(directory):
 
 # What packages are required for this module to be executed?
 REQUIRED = [
+    f'aim-ui=={__version__}',
     'aimrecords==0.0.7',
     'aimrocks==0.1.0',
     'cachetools>=4.0.0',
@@ -128,7 +126,7 @@ def run(self):
     setup_requires=SETUP_REQUIRED,
     install_requires=REQUIRED,
     packages=packages,
-    package_data={'aim': ui_files + migration_files + storage_migration_files + version_files},
+    package_data={'aim': migration_files + storage_migration_files + version_files},
     include_package_data=True,
     classifiers=[
         'License :: OSI Approved :: MIT License',
@@ -215,5 +213,5 @@ def run(self):
     },
     cmdclass={
         'upload': UploadCommand
-    },
+    }
 )