twrate 0.5.1__tar.gz

twrate-0.5.1/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 0

twrate-0.5.1/.github/workflows/bump-version.yml

@@ -0,0 +1,38 @@
+name: Bump Version
+
+on:
+  workflow_dispatch:
+    inputs:
+      bump-type:
+        description: "Bump type"
+        required: true
+        default: "patch"
+        type: choice
+        options:
+          - major
+          - minor
+          - patch
+
+permissions:
+  contents: write
+
+jobs:
+  bump-version:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+      - name: Bump version
+        id: bump
+        uses: callowayproject/bump-my-version@master
+        env:
+          BUMPVERSION_TAG: "true"
+        with:
+          args: ${{ inputs.bump-type }}
+          # Use a Personal Access Token (PAT) to ensure the publish workflow is triggered on tag push
+          github-token: ${{ secrets.PAT_TOKEN }}
+      - name: Check
+        if: steps.bump.outputs.bumped == 'true'
+        run: |
+          echo "Version was bumped from ${{ steps.bump.outputs.previous-version }} to ${{ steps.bump.outputs.current-version }}!"

twrate-0.5.1/.github/workflows/cron.yml

@@ -0,0 +1,25 @@
+name: Cron
+
+on:
+  workflow_dispatch:
+  # schedule:
+  #   - cron: "0 0 * * *"
+
+jobs:
+  cron:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Run
+        run: uv run python scripts/db.py
+        env:
+          INFLUXDB_URL: ${{ secrets.INFLUXDB_URL }}
+          INFLUXDB_TOKEN: ${{ secrets.INFLUXDB_TOKEN }}
+          INFLUXDB_ORG: ${{ secrets.INFLUXDB_ORG }}
+          INFLUXDB_BUCKET: ${{ secrets.INFLUXDB_BUCKET }}

twrate-0.5.1/.github/workflows/docker.yml

@@ -0,0 +1,46 @@
+name: Docker
+
+on:
+  workflow_dispatch:
+  push:
+    # branches:
+    #   - main
+    tags:
+      - "v*.*.*"
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      # https://docs.docker.com/build/ci/github-actions/manage-tags-labels/
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v6
+        with:
+          images: |
+            ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}
+          flavor: |
+            latest=auto
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v4
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v4
+      - name: Login to Docker Hub
+        uses: docker/login-action@v4
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push
+        uses: docker/build-push-action@v7
+        with:
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

twrate-0.5.1/.github/workflows/python.yml

@@ -0,0 +1,30 @@
+name: Python
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  python:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: uv sync
+      - name: Lint
+        run: uv run ruff check .
+      - name: Type check
+        run: uv run ty check .
+      - name: Test
+        run: uv run pytest -v -s --cov=src --cov-report=xml tests

twrate-0.5.1/.github/workflows/release.yml

@@ -0,0 +1,56 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: "3.12"
+      - name: Build distributions
+        run: uv build
+      - name: Upload distributions
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/*
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist
+      - uses: astral-sh/setup-uv@v7
+      - name: Publish to PyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: uv publish
+
+  github-release:
+    runs-on: ubuntu-latest
+    needs: publish
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist
+      - name: Create GitHub release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create "${{ github.ref_name }}" dist/* \
+            --repo "${{ github.repository }}" \
+            --title "${{ github.ref_name }}" \
+            --generate-notes

twrate-0.5.1/.gitignore

@@ -0,0 +1,135 @@
+# 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/
+pip-wheel-metadata/
+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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+
+# ruff
+.ruff_cache/
+
+# VS Code
+.vscode/

twrate-0.5.1/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.10
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.9.18
+    hooks:
+      - id: uv-lock
+  - repo: local
+    hooks:
+      - id: ty-check
+        name: ty-check
+        entry: ty check .
+        language: python
+        pass_filenames: false

twrate-0.5.1/AGENTS.md

@@ -0,0 +1,191 @@
+# Agents Architecture
+
+## Purpose
+
+`twrate` uses a fetcher-based architecture: each async fetcher pulls exchange rates from one Taiwanese bank and returns a shared `Rate` model. Fetchers run concurrently for fast fan-out and easy comparison across sources.
+
+## Workflow
+
+Use `uv` for all Python operations:
+
+```bash
+# Fetch rates
+uv run twrate USD
+
+# Tests
+uv run pytest
+
+# Dependencies
+uv sync
+uv add <package-name>
+
+# Run scripts / one-liners (always use uv)
+uv run python script.py
+uv run python -c "import httpx; print(httpx.__version__)"
+```
+
+Why `uv`:
+- Fast dependency management
+- Managed virtualenv
+- Reproducible via `uv.lock`
+
+Important: Always use `uv run python` instead of `python` or `python3`.
+
+## Core Models
+
+### Rate (`types.py`)
+
+```python
+class Rate(BaseModel):
+    exchange: Exchange          # Bank identifier
+    source: str                 # Source currency code
+    target: str                 # Target currency (usually "TWD")
+    spot_buy: float | None
+    spot_sell: float | None
+    cash_buy: float | None
+    cash_sell: float | None
+    fetched_at: datetime
+```
+
+Computed properties:
+- `spot_mid`, `cash_mid`
+- `spot_spread`, `cash_spread`
+- `symbol`
+
+### Exchange (`types.py`)
+
+Supported banks:
+- `DBS`, `SINOPAC`, `BOT`, `ESUN`, `LINE`, `HSBC`, `NEXT`, `KGI`, `CATHAY`
+
+## Fetcher Contract
+
+Each fetcher exposes `async def fetch_*_rates() -> list[Rate]` and follows:
+1. Single bank responsibility
+2. Consistent return type (`list[Rate]`)
+3. HTTP errors via `raise_for_status()`
+4. Pydantic for validation
+5. Async first (`httpx.AsyncClient`, `asyncio.gather()`)
+
+## Fetchers by Bank
+
+- **BOT** (`bot.py`) — Text API `https://rate.bot.com.tw/xrt/fltxt/0/day`; UTF-8-SIG parsing; fixed columns; spot + cash.
+- **DBS** (`dbs.py`) — JSON API `https://www.dbs.com.tw/tw-rates-api/v1/api/twrates/latestForexRates`; nested Pydantic models; cash often missing.
+- **ESUN** (`esun.py`) — JSON POST `https://www.esunbank.com/api/client/ExchangeRate/LastRateInfo`; `/Date(ts)/` parsing; dash as missing.
+- **LINE** (`line.py`) — HTML `https://www.linebank.com.tw/board-rate/exchange-rate`; USD/TWD only; spot only.
+- **SINOPAC** (`sinopac.py`) — Two JSON endpoints; merge spot + cash via `merge_rates()`.
+- **HSBC** (`hsbc.py`) — HTML `https://www.hsbc.com.tw/currency-rates/`; regex currency codes; dash as missing.
+- **NEXT** (`nextbank.py`) — HTML `https://www.nextbank.com.tw/exchange-rates`; strict ISO currency validation.
+- **KGI** (`kgi.py`) — HTML `https://www.kgibank.com.tw/zh-tw/personal/interest-rate/fx`; desktop/mobile tables; numeric-or-dash guard.
+- **CATHAY** (`cathay.py`) — HTML `https://www.cathaybk.com.tw/cathaybk/personal/product/deposit/currency-billboard/`; clean CSS structure; spot + cash.
+
+## Dispatcher
+
+`fetch_rates()` in `fetcher.py` routes to the correct fetcher by `Exchange`.
+
+```python
+async def fetch_rates(exchange: Exchange) -> list[Rate]:
+    match exchange:
+        case Exchange.SINOPAC:
+            return await fetch_sinopac_rates()
+        case Exchange.ESUN:
+            return await fetch_esun_rates()
+        case Exchange.LINE:
+            return await fetch_line_rates()
+        case Exchange.BOT:
+            return await fetch_bot_rates()
+        case Exchange.DBS:
+            return await fetch_dbs_rates()
+        case Exchange.HSBC:
+            return await fetch_hsbc_rates()
+        case Exchange.NEXT:
+            return await fetch_nextbank_rates()
+        case Exchange.KGI:
+            return await fetch_kgi_rates()
+        case Exchange.CATHAY:
+            return await fetch_cathay_rates()
+        case _:
+            raise ValueError(f"Unsupported exchange: {exchange}")
+```
+
+## Adding a Fetcher
+
+1. Create a module in `src/twrate/fetchers/`.
+2. Add an `Exchange` enum value in `types.py`.
+3. Implement `async def fetch_*_rates()` returning `list[Rate]`.
+4. Wire it in `fetcher.py`.
+5. Add tests in `tests/`.
+
+Template:
+
+```python
+import httpx
+from ..types import Exchange, Rate
+
+async def fetch_example_rates() -> list[Rate]:
+    url = "https://example.bank.com/api/rates"
+
+    async with httpx.AsyncClient() as client:
+        resp = await client.get(url)
+        resp.raise_for_status()
+
+        rates = []
+        for item in resp.json():
+            rates.append(
+                Rate(
+                    exchange=Exchange.EXAMPLE,
+                    source=item["currency"],
+                    target="TWD",
+                    spot_buy=item["buy"],
+                    spot_sell=item["sell"],
+                    cash_buy=item.get("cash_buy"),
+                    cash_sell=item.get("cash_sell"),
+                )
+            )
+
+    return rates
+```
+
+## Error Handling
+
+- HTTP errors bubble up (`raise_for_status()`).
+- Pydantic validation errors bubble up.
+- Missing values use `None` (or parsed dash placeholders).
+
+## Testing
+
+- Unit tests: `tests/test_fetcher.py`
+- Sample data: `tests/data/`
+- Integration tests may hit real endpoints.
+
+## Dependencies
+
+- `httpx`
+- `pydantic`
+- `beautifulsoup4`
+- `loguru`
+
+## Troubleshooting: JS-rendered Pages (Taishin Case)
+
+Summary: Taishin’s rate table is client-side rendered, so `httpx + BeautifulSoup` returns no data. Playwright can render it but adds heavy deps.
+
+Verification:
+```bash
+uv run python -c "\
+import httpx; from bs4 import BeautifulSoup; \
+resp = httpx.get('https://www.taishinbank.com.tw/TSB/personal/deposit/lookup/realtime/'); \
+soup = BeautifulSoup(resp.text, 'html.parser'); \
+print(f'Tables: {len(soup.find_all(\"table\"))}'); \
+print('USD in response:', '美元USD' in resp.text)\
+"
+```
+
+Decision: keep fetcher lightweight and accept no data for JS-only sites unless the source is critical.
+
+## Future Enhancements
+
+- Retry with backoff
+- Caching with TTL
+- Rate limiting per bank
+- Health checks
+- Historical rates
+- Optional Playwright for JS-heavy sites

twrate-0.5.1/Dockerfile

@@ -0,0 +1,28 @@
+# https://docs.astral.sh/uv/guides/integration/docker/#non-editable-installs
+ARG PYTHON_VERSION=3.12
+ARG DEBIAN_VERSION=bookworm
+FROM ghcr.io/astral-sh/uv:python${PYTHON_VERSION}-${DEBIAN_VERSION}-slim AS uv
+
+WORKDIR /app
+
+ENV UV_COMPILE_BYTECODE=1
+ENV UV_LINK_MODE=copy
+
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --frozen --no-install-project --no-dev --no-editable
+
+ADD . /app
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --frozen --no-dev --no-editable
+
+FROM python:${PYTHON_VERSION}-slim-${DEBIAN_VERSION}
+
+WORKDIR /app
+
+COPY --from=uv --chown=app:app /app/.venv /app/.venv
+
+ENV PATH="/app/.venv/bin:$PATH"
+
+ENTRYPOINT ["twrate"]

twrate-0.5.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 なるみ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

twrate-0.5.1/Makefile

@@ -0,0 +1,19 @@
+format:
+	uv run ruff format .
+
+lint:
+	uv run ruff check --fix .
+
+type:
+	uv run mypy --install-types --non-interactive .
+
+test:
+	uv run pytest -v -s --cov=src tests
+
+publish:
+	uv build -f wheel
+	uv publish
+
+all: format lint type test
+
+.PHONY: lint test publish