chore!: v0.4.1をマージする

.github/workflows/ci.yaml

@@ -6,35 +6,37 @@ name: Python package
 on:
   push:
     branches: [ master ]
+    tags:
+      - 'v*'
   pull_request:
     branches: [ master ]
 
 jobs:
-  build:
-
+  test:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         include:
-          - os: ubuntu-latest
-            python-version: 3.7
           - os: ubuntu-latest
             python-version: 3.8
           - os: ubuntu-latest
             python-version: 3.9
           - os: ubuntu-latest
             python-version: '3.10'
+          - os: ubuntu-latest
+            python-version: '3.11'
           - os: macos-latest
             python-version: 3.9
           - os: windows-latest
             python-version: 3.9
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
+        fetch-depth: 0
         submodules: true
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
@@ -48,3 +50,78 @@ jobs:
       run: |
         pip install pytest
         pytest
+
+  build-for-publish:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+    if: "startsWith(github.ref, 'refs/tags')"
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: true
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade build
+
+      - name: Build a source tarball and wheel
+        run: python -m build .
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          # NOTE: for now upload sdist only to prevent errors like unsupported platform tag 'linux_x86_64'.
+          path: dist/*.tar.gz
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build-for-publish
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pyopenjtalk
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+
+  # NOTE: for testing purposes only
+  # publish-to-testpypi:
+  #   name: Publish Python 🐍 distribution 📦 to TestPyPI
+  #   needs:
+  #   - build-for-publish
+  #   runs-on: ubuntu-latest
+  #   environment:
+  #     name: testpypi
+  #     url: https://test.pypi.org/p/pyopenjtalk
+  #   permissions:
+  #     id-token: write  # IMPORTANT: mandatory for trusted publishing
+  #   steps:
+  #   - name: Download all the dists
+  #     uses: actions/download-artifact@v4
+  #     with:
+  #       name: python-package-distributions
+  #       path: dist/
+  #   - name: Publish distribution 📦 to TestPyPI
+  #     uses: pypa/gh-action-pypi-publish@release/v1
+  #     with:
+  #       repository-url: https://test.pypi.org/legacy/
+  #       verbose: true

MANIFEST.in

@@ -1,4 +1,7 @@
-include README.md LICENSE.md
-recursive-include pyopenjtalk *.cpp *.pxd *.md *.pyx
-recursive-include lib *.cpp *.c *.h README LICENSE COPYING CMakeLists.txt *.in
+include pyopenjtalk/version.py
+exclude .gitignore .gitmodules .travis.yml tox.ini
+prune .github/*
+prune docs/**
+recursive-include lib *.cpp *.c *.h README COPYING CMakeLists.txt *.in
 exclude lib/open_jtalk/src/mecab/src/config.h
+prune lib/open_jtalk/src/build/**

README.md

@@ -105,52 +105,56 @@ In [3]: pyopenjtalk.g2p("こんにちは", kana=True)
 Out[3]: 'コンニチワ'
 ```
 
-### About `run_marine` option
+### Create/Apply user dictionary
 
-After v0.3.0, the `run_marine` option has been available for estimating the Japanese accent with the DNN-based method (see [marine](https://github.com/6gsn/marine)). If you want to use the feature, please install pyopenjtalk as below;
+1. Create a CSV file (e.g. `user.csv`) and write custom words like below:
 
-```shell
-pip install pyopenjtalk[marine]
+```csv
+ＧＮＵ,,,1,名詞,一般,*,*,*,*,ＧＮＵ,グヌー,グヌー,2/3,*
 ```
 
-And then, you can use the option as the following examples;
+2. Call `mecab_dict_index` to compile the CSV file.
 
 ```python
 In [1]: import pyopenjtalk
 
-In [2]: x, sr = pyopenjtalk.tts("おめでとうございます", run_marine=True) # for TTS
+In [2]: pyopenjtalk.mecab_dict_index("user.csv", "user.dic")
+reading user.csv ... 1
+emitting double-array: 100% |###########################################|
 
-In [3]: label = pyopenjtalk.extract_fullcontext("こんにちは", run_marine=True) # for text processing frontend only
+done!
 ```
 
-### Create/Apply user dictionary
+3. Call `update_global_jtalk_with_user_dict` to apply the user dictionary.
 
-1. Create a CSV file (e.g. `user.csv`) and write custom words like below:
+```python
+In [3]: pyopenjtalk.g2p("GNU")
+Out[3]: 'j i i e n u y u u'
 
-```csv
-ＧＮＵ,,,1,名詞,一般,*,*,*,*,ＧＮＵ,グヌー,グヌー,2/3,*
+In [4]: pyopenjtalk.update_global_jtalk_with_user_dict("user.dic")
+
+In [5]: pyopenjtalk.g2p("GNU")
+Out[5]: 'g u n u u'
 ```
 
-2. Call `create_user_dict` to compile the CSV file.
+### About `run_marine` option
 
-```
->>> import pyopenjtalk
->>> pyopenjtalk.create_user_dict("user.csv", "user.dic")
-reading user.csv ... 1
-emitting double-array: 100% |###########################################| 
+After v0.3.0, the `run_marine` option has been available for estimating the Japanese accent with the DNN-based method (see [marine](https://github.com/6gsn/marine)). If you want to use the feature, please install pyopenjtalk as below;
 
-done!
+```shell
+pip install pyopenjtalk[marine]
 ```
 
-3. Call `set_user_dict` to apply the user dictionary.
+And then, you can use the option as the following examples;
 
+```python
+In [1]: import pyopenjtalk
+
+In [2]: x, sr = pyopenjtalk.tts("おめでとうございます", run_marine=True) # for TTS
+
+In [3]: label = pyopenjtalk.extract_fullcontext("こんにちは", run_marine=True) # for text processing frontend only
 ```
->>> pyopenjtalk.g2p("GNU")
-'j i i e n u y u u'
->>> pyopenjtalk.set_user_dict("user.dic")
->>> pyopenjtalk.g2p("GNU")
-'g u n u u'
-```
+
 
 ## LICENSE