build ui into the package

Author: wj-Mcat

.github/workflows/pypi.yml

@@ -63,13 +63,19 @@ jobs:
           python -m pip install --upgrade pip
           pip install setuptools wheel twine
           make install
+
       - name: Check Branch
         id: check-branch
         run: |
           if [[ ${{ github.ref }} =~ ^refs/heads/(master|v[0-9]+\.[0-9]+.*)$ ]]; then
               echo ::set-output name=match::true
           fi  # See: https://stackoverflow.com/a/58869470/1123955
 
+      - name: Check Branch
+        id: check-branch
+        run: |
+          make ui
+
       - name: Is A Publish Branch
         if: steps.check-branch.outputs.match == 'true'
         env:

MANIFEST.in

@@ -1,4 +1,4 @@
 include LICENSE README.md VERSION
 recursive-include src **/*.py
-recursive-include src **/*.pyi
-recursive-exclude src **/*_test.py
+recursive-include src **/*.pyi **/ui/
+recursive-exclude src **/*_test.py **/__pycache__ **/.mypy_cache

Makefile

@@ -20,7 +20,7 @@ all : clean lint
 
 .PHONY: clean
 clean:
-	rm -fr dist/* .pytype ./src/wechaty/**/*.pyi ./src/wechaty/*.pyi
+	rm -fr dist/* .pytype src/wechaty/ui ui/
 
 .PHONY: lint
 lint: pylint pycodestyle flake8 mypy
@@ -113,6 +113,10 @@ code:
 run:
 	python3 bin/run.py
 
+.PHONY: ui
+ui:
+	./scripts/build_ui.sh
+
 .PHONY: dist
 dist:
 	python3 setup.py sdist bdist_wheel

requirements-dev.txt

@@ -12,7 +12,7 @@ pytest
 pytest-asyncio==0.18.3
 pytest-cov
 pytype
-semver
+semver==3.0.0.dev3
 pyee
 requests
 qrcode

scripts/build_ui.sh

@@ -0,0 +1,11 @@
+# start to build wechaty-ui into wechaty
+
+make clean
+git clone https://github.com/wechaty/wechaty-ui ui 
+cd ui
+cnpm i && cnpm run build
+
+# move the dist files to 
+echo "starting to copy files to the package ..."
+pwd
+cp -r dist/ ../src/wechaty/ui

setup.py

@@ -76,7 +76,8 @@ def get_install_requires() -> List[str]:
     long_description_content_type='text/markdown',
     license='Apache-2.0',
     url='https://github.com/wechaty/python-wechaty',
-    packages=setuptools.find_packages('src'),
+    packages=setuptools.find_packages('src', exclude=['__pycache__', '.mypy_cache']),
+    include_package_data=True,
     package_dir={'wechaty': 'src/wechaty'},
     install_requires=get_install_requires(),
     classifiers=[

src/wechaty/config.py

@@ -92,21 +92,27 @@ class Config:
     """
     get the configuration from the environment variables
     """
-    def __init__(self) -> None:
-        self._cache_dir: Optional[str] = None
-
     @property
     def cache_dir(self) -> str:
         """get the cache dir in the lazy loading mode
 
         Returns:
             str: the path of cache dir
         """
-        if self._cache_dir is not None:
-            return self._cache_dir
-        self._cache_dir = os.environ.get("CACHE_DIR", '.wechaty')
-        assert self._cache_dir is not None
-        return self._cache_dir
+        return os.environ.get("CACHE_DIR", '.wechaty')
+    
+    @property
+    def ui_dir(self) -> str:
+        """get the ui directory
+
+        Returns:
+            str: the path of the ui dir 
+        """
+        default_ui_dir = os.path.join(
+            os.path.dirname(__file__),
+            'ui'
+        )
+        return os.environ.get("UI_DIR", default_ui_dir)
 
 
 # export const CHATIE_OFFICIAL_ACCOUNT_ID = 'gh_051c89260e5d'