sympy-reading 0.1.0__tar.gz

sympy_reading-0.1.0/.coveragerc

@@ -0,0 +1,2 @@
+[run]
+branch = True

sympy_reading-0.1.0/.github/renovate.json5

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended",
+    ":dependencyDashboard",
+    "default:pinDigestsDisabled",
+    "local>kitsuyui/renovate-config:npm.json5#cdad3c71e34e5abadf909c996906011bbc2b5725",
+    "local>kitsuyui/renovate-config:python.json5#cdad3c71e34e5abadf909c996906011bbc2b5725",
+    "local>kitsuyui/renovate-config:cargo.json5#cdad3c71e34e5abadf909c996906011bbc2b5725",
+    "local>kitsuyui/renovate-config:gha.json5#cdad3c71e34e5abadf909c996906011bbc2b5725",
+    "local>kitsuyui/renovate-config:pin.json5#cdad3c71e34e5abadf909c996906011bbc2b5725",
+    "local>kitsuyui/renovate-config:lockfile.json5#cdad3c71e34e5abadf909c996906011bbc2b5725"
+  ],
+  "git-submodules": {
+    "enabled": true
+  },
+  "timezone": "Asia/Tokyo",
+  "schedule": [
+    "before 9am every weekday",
+    "every weekend"
+  ]
+}

sympy_reading-0.1.0/.github/workflows/gitignore-in.yml

@@ -0,0 +1,14 @@
+name: Update gitignore file
+
+on:
+  schedule:
+    # daily at 00:00
+    - cron: '0 0 * * *'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update-gitignore:
+    uses: kitsuyui/gh-actions-workflows/.github/workflows/gitignore-in.yml@3717c78af3a5e594b7a81b063276e15fac7e08fc

sympy_reading-0.1.0/.github/workflows/happy.yml

@@ -0,0 +1,10 @@
+name: happy-commit
+on:
+  - pull_request
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write
+jobs:
+  happy:
+    uses: kitsuyui/gh-actions-workflows/.github/workflows/happy-commit.yml@3717c78af3a5e594b7a81b063276e15fac7e08fc

sympy_reading-0.1.0/.github/workflows/octocov.yml

@@ -0,0 +1,62 @@
+name: octocov
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  pull-requests: write
+  checks: write
+
+jobs:
+  octocov:
+    runs-on: macos-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.13"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+        with:
+          persist-credentials: false
+
+      - name: install shared libraries
+        run: |
+          brew install openblas
+          brew install lapack
+
+      - name: Set up Python
+        id: setup-python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
+        with:
+          python-version: "${{ matrix.python }}"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: |
+          uv python pin ${{ matrix.python }}
+          uv sync
+
+      - name: Test
+        run: uv run poe test
+
+      - name: Coverage
+        run: uv run poe coverage-xml
+
+      # See also: https://github.com/k1LoW/octocov-action
+      - name: Report coverage with octocov
+        uses: k1LoW/octocov-action@b3b6ee60482a667950f87553abf1df63217235d9 # v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          config: .octocov.yml

sympy_reading-0.1.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,98 @@
+name: Packaging
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  release:
+    # "released" events are emitted either when directly be released or be edited from pre-released.
+    types: [prereleased, released]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  python_version: 3.13
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+        with:
+          persist-credentials: false
+
+      - name: Enable caching
+        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        with:
+          enable-cache: true
+
+      - run: |
+          uv python pin ${{ env.python_version }}
+          uv sync
+
+      - name: Build
+        run: uv build
+
+  publish-test-pypi:
+    name: Publish distribution to Test PyPI
+    if: github.event_name == 'release' && github.event.release.prerelease
+    needs: build
+    runs-on: ubuntu-latest
+    environment: test-pypi
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd
+        with:
+          persist-credentials: false
+
+      - name: Enable caching
+        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e
+        with:
+          enable-cache: true
+
+      - run: |
+          uv python pin ${{ env.python_version }}
+          uv sync
+
+      - name: Build
+        run: uv build
+
+      - name: Publish distribution to Test PyPI
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    name: Publish distribution to PyPI
+    if: github.event_name == 'release' && !github.event.release.prerelease
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd
+        with:
+          persist-credentials: false
+
+      - name: Enable caching
+        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e
+        with:
+          enable-cache: true
+
+      - run: |
+          uv python pin ${{ env.python_version }}
+          uv sync
+
+      - name: Build
+        run: uv build
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b

sympy_reading-0.1.0/.github/workflows/python-test.yml

@@ -0,0 +1,62 @@
+name: Test
+on:
+  # pull-request events are not triggered when a PR is merged
+  # push events are not triggered when a PR created from a fork repository
+  # So we need both to run tests on every PR and after merging
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  actionlint:
+    uses: kitsuyui/gh-actions-workflows/.github/workflows/actionlint.yml@3717c78af3a5e594b7a81b063276e15fac7e08fc # main
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+
+      - name: Set up Python
+        id: setup-python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
+        with:
+          python-version: "${{ matrix.python }}"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Lint
+        run: uv run poe check
+
+      - name: Check Python version
+        run: |
+          actual_version=$(uv run python --version)
+          expected_version="Python ${{ matrix.python }}"
+          if [[ "$actual_version" != *"$expected_version"* ]]; then
+            echo "Expected $expected_version, but got $actual_version"
+            exit 1
+          fi
+
+      - name: Test
+        run: uv run poe test
+
+      - name: Coverage
+        run: uv run poe coverage-xml

sympy_reading-0.1.0/.github/workflows/spellcheck.yml

@@ -0,0 +1,8 @@
+name: Spellcheck
+on:
+  - pull_request
+permissions:
+  contents: read
+jobs:
+  check:
+    uses: kitsuyui/gh-actions-workflows/.github/workflows/spellcheck.yml@3717c78af3a5e594b7a81b063276e15fac7e08fc # main

sympy_reading-0.1.0/.gitignore

@@ -0,0 +1,249 @@
+# DO NOT EDIT THIS FILE
+# Generated by gitignore.in
+# Edit .gitignore.in instead of this file
+# Run `gitignore.in` to build .gitignore
+# -----------------------------------------------------------------------------
+# gibo dump Linux
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/Linux.gitignore
+
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+# -----------------------------------------------------------------------------
+# gibo dump Windows
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/Windows.gitignore
+
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+# -----------------------------------------------------------------------------
+# gibo dump macOS
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/macOS.gitignore
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+# -----------------------------------------------------------------------------
+# gibo dump Python
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+# -----------------------------------------------------------------------------
+sympy_reading/_version.py

sympy_reading-0.1.0/.gitignore.in

@@ -0,0 +1,5 @@
+gibo dump Linux
+gibo dump Windows
+gibo dump macOS
+gibo dump Python
+echo 'sympy_reading/_version.py'

sympy_reading-0.1.0/.octocov.yml

@@ -0,0 +1,22 @@
+# https://github.com/k1LoW/octocov?tab=readme-ov-file#configuration
+coverage:
+  acceptable: 98%
+  paths:
+    - coverage.xml
+codeToTestRatio:
+  code:
+    - "**/*.py"
+  test:
+    - "tests/**/*.py"
+testExecutionTime:
+  if: true
+diff:
+  datastores:
+    - artifact://${GITHUB_REPOSITORY}
+comment:
+  if: is_pull_request
+  updatePrevious: true
+report:
+  if: is_default_branch
+  datastores:
+    - artifact://${GITHUB_REPOSITORY}

sympy_reading-0.1.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: sympy-reading
+Version: 0.1.0
+Summary: Sympy equation to human-readable string
+Author-email: Yui KITSU <kitsuyui+github@kitsuyui.com>
+Project-URL: Homepage, https://github.com/kitsuyui/sympy-reading
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: sympy>=1.12
+
+# sympy-reading
+
+![Coverage](https://raw.githubusercontent.com/kitsuyui/octocov-central/main/badges/kitsuyui/sympy-reading/coverage.svg)
+
+Convert a small subset of SymPy expressions into Japanese readings.
+
+## Installation
+
+```sh
+pip install sympy-reading
+```
+
+## Usage
+
+```python
+import sympy
+from sympy_reading import to_reading
+
+# Single integer
+print(to_reading(sympy.Integer(3)))
+# => さん
+
+# Equation: wrap in sympy.evaluate(False) to preserve the unevaluated form
+with sympy.evaluate(False):
+    eq = sympy.Eq(sympy.Add(11, 22), 33)
+    print(to_reading(eq))
+    # => じゅういち たす にじゅうに いこーる さんじゅうさん
+
+# Multiplication
+with sympy.evaluate(False):
+    eq = sympy.Eq(sympy.Mul(2, 3, 4), 24)
+    print(to_reading(eq))
+    # => に かける さん かける よん いこーる にじゅうよん
+```
+
+> **Note:** Always wrap `Add` and `Mul` expressions in `sympy.evaluate(False)`
+> (or pass `evaluate=False` to the constructor). Without it, SymPy evaluates
+> the expression before `to_reading()` can inspect the operator, so the
+> structure is lost.
+
+## Supported expression scope
+
+This package currently supports a narrow, explicit subset:
+
+- non-negative SymPy integer constants;
+- `sympy.Add` and `sympy.Mul` expressions whose operands are recursively in
+  the supported subset;
+- `sympy.Eq` equations whose left and right sides are recursively in the
+  supported subset.
+
+`Add` is read as infix `たす`, `Mul` is read as infix `かける`, and `Eq` is
+read as `いこーる`.
+
+Unsupported expressions raise `NotImplementedError`, including symbols,
+negative integers, rationals, floats, functions, powers, inequalities, and
+operators other than `Add` and `Mul`.
+
+## Version Status
+
+This package is currently classified as `Development Status :: 3 - Alpha`.
+The API may change without notice.
+A stable release will be tagged when the supported expression scope stabilizes and breaking changes become unlikely.
+
+## Development
+
+This repository uses [lefthook](https://lefthook.dev/) to run the same checks as CI
+locally, so problems surface before they reach CI.
+
+```sh
+# Install dependencies
+uv sync
+
+# Install the Git hooks (once; requires lefthook on your PATH)
+lefthook install
+```
+
+Once installed, the hooks run automatically:
+
+- **pre-commit**: `uv run poe check`
+- **pre-push**: `uv run poe check` and `uv run poe test`
+
+You can also run the checks manually:
+
+```sh
+uv run poe check
+uv run poe test
+```
+
+CI still runs the full matrix (see `.github/workflows/`); the hooks only bring that
+feedback earlier on your machine.