dividendcase 0.1.0__tar.gz

dividendcase-0.1.0/.github/workflows/build.yml

@@ -0,0 +1,87 @@
+name: Build
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: build-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  interface:
+    name: Interface and website
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 22
+          cache: npm
+      - name: Install
+        run: npm ci --no-audit --no-fund
+      - name: Type-check
+        run: |
+          npx tsc --noEmit -p frontend
+          npx tsc --noEmit -p site
+      - name: Build the website
+        run: npm run build -w site
+
+  package:
+    name: Package
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 22
+          cache: npm
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Build the interface into the package
+        run: uv run python scripts/build_web.py
+      - name: Serve the built pages
+        run: uv run pytest tests/test_api.py -k interface
+      - name: Build the wheel and sdist
+        run: uv build
+      - name: Check them
+        run: uv run python scripts/check_dist.py
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 7
+
+  install:
+    name: Install and run (${{ matrix.os }})
+    needs: package
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ${{ github.event_name == 'pull_request' && fromJSON('["ubuntu-latest"]') || fromJSON('["ubuntu-latest", "macos-latest", "windows-latest"]') }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/download-artifact@v5
+        with:
+          name: dist
+          path: dist/
+      - uses: astral-sh/setup-uv@v6
+      - name: uv tool install, as the README says
+        run: |
+          uv tool install "$(ls dist/*.whl)"
+          echo "$(uv tool dir --bin)" >> "$GITHUB_PATH"
+      - name: Start it and check it works
+        run: uv run --no-project python scripts/smoke_test.py

dividendcase-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,151 @@
+name: Release
+
+# A release is a tag: bump `version` in pyproject.toml, add a CHANGELOG.md section with the
+# same number, merge, then push the tag `v<version>`. PyPI trusts this workflow directly
+# (trusted publishing), so there are no tokens or passwords in the repository.
+#
+# Run it by hand ("Run workflow") for a dry run on TestPyPI instead.
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+    inputs:
+      testpypi:
+        description: Publish to TestPyPI (a dry run; real releases come from a v* tag)
+        type: boolean
+        default: true
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build and test
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 22
+          cache: npm
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Version matches the tag
+        id: version
+        run: |
+          version=$(uv run --no-project python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+          if [ "$GITHUB_REF_TYPE" = "tag" ] && [ "$GITHUB_REF_NAME" != "v$version" ]; then
+            echo "::error::The tag $GITHUB_REF_NAME doesn't match the version in pyproject.toml ($version)"
+            exit 1
+          fi
+          if ! grep -q "^## $version\$" CHANGELOG.md; then
+            echo "::error::CHANGELOG.md has no '## $version' section"
+            exit 1
+          fi
+      - name: Tests
+        run: |
+          uv sync --locked
+          uv run pytest
+          uv run python -m dividendcase.migrate check
+      - name: Build the interface into the package
+        run: uv run python scripts/build_web.py
+      - name: Build the wheel and sdist
+        run: uv build
+      - name: Check them
+        run: uv run python scripts/check_dist.py "${{ steps.version.outputs.version }}"
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 30
+
+  install:
+    name: Install and run (${{ matrix.os }})
+    needs: build
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/download-artifact@v5
+        with:
+          name: dist
+          path: dist/
+      - uses: astral-sh/setup-uv@v6
+      - name: uv tool install, as the README says
+        run: |
+          uv tool install "$(ls dist/*.whl)"
+          echo "$(uv tool dir --bin)" >> "$GITHUB_PATH"
+      - name: Start it and check it works
+        run: uv run --no-project python scripts/smoke_test.py
+
+  testpypi:
+    name: Publish to TestPyPI
+    if: github.event_name == 'workflow_dispatch' && inputs.testpypi
+    needs: [build, install]
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # trusted publishing
+    steps:
+      - uses: actions/download-artifact@v5
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+  pypi:
+    name: Publish to PyPI
+    if: github.ref_type == 'tag'
+    needs: [build, install]
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # trusted publishing
+    steps:
+      - uses: actions/download-artifact@v5
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: GitHub release
+    if: github.ref_type == 'tag'
+    needs: [build, pypi]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/download-artifact@v5
+        with:
+          name: dist
+          path: dist/
+      - name: Create the release with the changelog's notes
+        env:
+          GH_TOKEN: ${{ github.token }}
+          VERSION: ${{ needs.build.outputs.version }}
+        run: |
+          awk -v heading="## $VERSION" '$0 == heading {found = 1; next} /^## / {found = 0} found' CHANGELOG.md > notes.md
+          printf '\n**Install:** `uv tool install dividendcase` · **Update:** `uv tool upgrade dividendcase`\n' >> notes.md
+          prerelease=""
+          if echo "$VERSION" | grep -q '[a-z]'; then prerelease="--prerelease"; fi
+          gh release create "$GITHUB_REF_NAME" dist/* --title "DividendCase $VERSION" --notes-file notes.md $prerelease

dividendcase-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,39 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    name: Python ${{ matrix.python }} (${{ matrix.os }})
+    # Pull requests: Linux only. main: every supported Python on Linux, plus macOS and Windows,
+    # where people install the app
+    strategy:
+      fail-fast: false
+      matrix:
+        include: ${{ fromJSON(github.event_name == 'pull_request' && '[{"os":"ubuntu-latest","python":"3.12"}]' || '[{"os":"ubuntu-latest","python":"3.11"},{"os":"ubuntu-latest","python":"3.12"},{"os":"ubuntu-latest","python":"3.13"},{"os":"macos-latest","python":"3.12"},{"os":"windows-latest","python":"3.12"}]') }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+    env:
+      UV_PYTHON: ${{ matrix.python }}
+    steps:
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Install
+        run: uv sync --locked
+      - name: Tests (real SQLite, no network)
+        run: uv run pytest
+      - name: Models and migrations agree
+        run: uv run python -m dividendcase.migrate check

dividendcase-0.1.0/.gitignore

@@ -0,0 +1,39 @@
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+*.egg-info/
+dist/
+build/
+
+# Interface, website and shared packages (npm workspaces)
+node_modules/
+.next/
+out/
+*.tsbuildinfo
+next-env.d.ts
+
+# The built interface is copied into the package at release time
+src/dividendcase/web/*
+!src/dividendcase/web/.gitkeep
+
+# Local data and secrets: never commit these
+*.db
+*.db-shm
+*.db-wal
+.env
+.env.*
+!.env.example
+# Only points `npm run dev` at the local API; no secrets
+!frontend/.env.development
+
+# OS / editors
+.DS_Store
+.idea/
+.vscode/
+
+# Personal Claude Code settings
+.claude/
+
+# Throwaway data folder for testing (DIVIDENDCASE_DATA_DIR)
+.test-data/

dividendcase-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

dividendcase-0.1.0/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to DividendCase. Versions follow [semantic versioning](https://semver.org/);
+while the version starts with 0, a minor release (0.2, 0.3…) may change things.
+
+## 0.1.0
+
+The first release of DividendCase as an app that runs on your own computer.
+
+- **Income home:** what your holdings should pay over the next 12 months, month by month, with upcoming payments, where the income comes from and a few plain-English notes.
+- **One currency:** totals across USD, GBP, EUR, INR, CAD, AUD and more are converted into your home currency with the European Central Bank's daily reference rates. Past amounts use the rate on their date, future income the latest rate.
+- **First-run setup:** tax residence, home currency and which markets the screener downloads.
+- **Stock pages:** 10 years of dividend history, TTM and forward yield, a safety score, dividend growth and growth streaks.
+- **Screener:** index members of the S&P 500, NIFTY 50, TSX 60, FTSE 100, ISEQ 20 and ASX 200, plus high-yield groups, filtered by market, yield and how often they pay.
+- **Portfolios:** up to four, with individual purchase lots in any currency, performance against a benchmark and diversification charts.
+- **Income calendar, watchlists, side-by-side comparison and a DRIP calculator.**
+- **Excel import and export** of portfolios, holdings and watchlists, and an Excel report.
+- **⌘K search** for any stock, page or action.
+- **Your data stays on your computer:** one SQLite file, market data fetched by your computer from Yahoo Finance for your own use, a copy saved before every upgrade, and a daily check for new versions that you can turn off.