fix: Resolve installation bug #292 and modernize package management (#325)

* fix: Resolve installation bug #292 and modernize package management

- Fix IndexError in setup.py version extraction logic
- Upgrade pynini dependency to support post-release versions
- Replace manual version management with setuptools_scm
- Migrate to modern pyproject.toml configuration
- Remove obsolete setup.py and requirements.txt
- Enable coexistence with nemo_text_processing in ChatTTS ecosystem

* feat: 更新CI工作流以支持现代Python打包

- 修改wheels.yml使用python -m build替代setup.py
- 添加build和twine依赖
- 实现智能版本检测(setuptools_scm)
- 优化工作流步骤结构
- 更新unittest.yml使用.[test]依赖安装

* fix: 回退pynini版本约束以解决测试失败问题

- 将pynini依赖从'>=2.1.6,<2.2.0'改回'==2.1.6'
- 解决因版本升级导致的UnitTest失败
- 等待CI验证是否为版本兼容性问题

* fix: 更新GitHub Actions到最新版本以解决deprecated警告

- 将actions/checkout从v3更新到v4
- 将actions/upload-artifact从v3更新到v4
- 解决因使用deprecated动作版本导致的构建失败

* feat: 添加PyPI发布条件限制

- 只在原仓库master分支推送时执行PyPI发布
- 避免fork仓库因缺少认证而失败
- 保持工作流完整性和可测试性

* feat: 放宽pynini版本限制以提高兼容性

- 将pynini依赖从'==2.1.6'改为'>=2.1.6,<2.1.7'
- 允许2.1.6.x系列的patch版本
- 保持与特定库的兼容性同时增加灵活性

* docs: improve version input description in wheels workflow

- Update description to clarify that version is optional
- Explain that setuptools_scm will determine version automatically if not provided
- Improve user experience for workflow dispatch

Author: WhizZest

.github/workflows/unittest.yml

@@ -13,15 +13,17 @@ jobs:
       matrix:
         python-version: [3.9]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
+          pip install .[test]
       - name: Lint with flake8
         run: |
           # stop the build if there are Python syntax errors or undefined names

.github/workflows/wheels.yml

@@ -4,8 +4,8 @@ on:
   workflow_dispatch:
     inputs:
       version:
-        description: 'Release version'
-        required: true
+        description: 'Release version (optional, will be determined by setuptools_scm if not provided)'
+        required: false
 
 jobs:
   build:
@@ -14,16 +14,18 @@ jobs:
       matrix:
         python-version: [3.9]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install wheel
+          pip install .[test]
+          pip install build twine
 
       - name: Build Graph
         run: |
@@ -37,17 +39,33 @@ jobs:
           cp tn/*.fst graph
           cp itn/*.fst graph
 
+      - name: Get version from setuptools_scm
+        id: scm_version
+        run: |
+          # Check if version is provided as input
+          if [ -n "${{ github.event.inputs.version }}" ]; then
+            echo "VERSION=${{ github.event.inputs.version }}" >> $GITHUB_OUTPUT
+          else
+            # Get version from setuptools_scm
+            pip install setuptools_scm
+            VERSION=$(python -m setuptools_scm | tail -1)
+            echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+          fi
+
       - name: Upload Graph
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: release-graph-v${{ github.event.inputs.version}}
+          name: release-graph-v${{ steps.scm_version.outputs.VERSION }}
           path: graph
 
+      - name: Build package
+        run: |
+          python -m build
+
       - name: Publish on pypi.org
+        if: github.ref == 'refs/heads/master' && github.repository == 'wenet-e2e/WeTextProcessing'
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
         run: |
-          python setup.py sdist bdist_wheel --version=${{ github.event.inputs.version}}
-          python -m pip install -U twine
-          python -m twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
+          python -m twine upload dist/*

.gitignore

@@ -42,3 +42,6 @@ build/
 dist/
 tn/*.far
 itn/*.far
+
+# Version file(setuptools_scm generated)
+tn/_version.py

pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "WeTextProcessing"
+authors = [
+    {name = "Zhendong Peng", email = "pzd17@tsinghua.org.cn"},
+    {name = "Xingchen Song", email = "sxc19@tsinghua.org.cn"}
+]
+description = "WeTextProcessing, including TN & ITN"
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+dynamic = ["version"]
+dependencies = [
+    # Core dependencies for text processing functionality
+    "pynini>=2.1.6,<2.1.7",
+    "importlib_resources"
+]
+
+[project.urls]
+Homepage = "https://github.com/wenet-e2e/WeTextProcessing"
+
+[project.scripts]
+wetn = "tn.main:main"
+weitn = "itn.main:main"
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "flake8"]
+dev = [
+    # Development tools
+    "flake8",
+    "pre-commit==3.5.0",
+    "pytest"
+]
+
+[tool.setuptools_scm]
+version_scheme = "guess-next-dev"
+local_scheme = "dirty-tag"
+write_to = "tn/_version.py"
+fallback_version = "1.0.5"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["tn*", "itn*"]
+namespaces = false
+
+[tool.setuptools.package-data]
+tn = ["*.fst", "chinese/data/*/*.tsv", "english/data/*/*.tsv", "english/data/*.tsv", "english/data/*/*.far"]
+itn = ["*.fst", "chinese/data/*/*.tsv"]