Metadata-Version: 2.4
Name: suca-pt
Version: 0.0.2
Summary: SUCA Portfolio Tracker: a local-first portfolio tracker for Indian family investment managers
Author: SUCA Analytics
License-Expression: LicenseRef-Proprietary
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3
Requires-Dist: cryptography>=50.0.2
Requires-Dist: keyring>=25.7.0
Requires-Dist: pdfplumber>=0.11.10
Requires-Dist: pikepdf>=10.16.0
Requires-Dist: platformdirs>=4.12.3
Requires-Dist: starlette>=1.7.0
Requires-Dist: uvicorn>=0.54.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# SUCA Portfolio Tracker

A portfolio tracker for Indian families who manage several demat accounts:
people, HUFs and companies, across brokers. It runs on your own Mac and opens
in your browser.

> **Early preview.** Versions 0.0.x install and run but have no portfolio
> features yet. They exist to prove installation and updates.

## Your data stays on your Mac

- The app listens only on `127.0.0.1`, so other devices on your network cannot
  reach it, and it serves only the browser tab it opened for you.
- Your statements, holdings and trades are never uploaded anywhere.
- The only request it makes to the internet is an optional check, once per
  launch, for a newer version on pypi.org. That request sends no data. You can
  turn it off (see *Options*).

## Requirements

An Apple Silicon Mac (M1 or later) running macOS 15 or later.

## Install

Open **Terminal** and run these two commands. The first installs
[uv](https://docs.astral.sh/uv/), a free Python installer. The second installs
the app with its own copy of Python, so nothing else on your Mac changes.

```sh
curl -LsSf https://astral.sh/uv/install.sh | sh
uv tool install --managed-python --python 3.14 suca-pt
```

Then open a **new** Terminal window and start it:

```sh
suca-pt
```

Your browser opens the app. Leave the Terminal window open while you use it.
To stop, click **Quit** in the app or press Ctrl-C in Terminal.

If `suca-pt` is not found, run `uv tool update-shell` and open a new window.

## Update

When the app shows that a new version is available, quit it, then run:

```sh
uv tool upgrade suca-pt
```

Your data is kept.

## Options

| Command | What it does |
|---|---|
| `suca-pt --no-browser` | Print the address instead of opening the browser |
| `suca-pt --port 8765` | Use a fixed port instead of a free one |
| `suca-pt --self-check` | Check that the app's components work on this Mac (prints no personal data) |
| `suca-pt --check-update` | Check for a new version and exit |
| `suca-pt --no-update-check` | Skip the update check this time |
| `SUCA_PT_NO_UPDATE_CHECK=1` | Skip it always (set in your shell profile) |
| `suca-pt --version` | Show the installed version |

## Uninstall

```sh
uv tool uninstall suca-pt
```

That removes the app. Your data stays in
`~/Library/Application Support/suca-pt`. Delete that folder to remove it too.

## Not advice

SUCA Portfolio Tracker reports what you hold and what it has earned. It does
not recommend what to buy or sell.

## Licence

© SUCA Analytics. All rights reserved. Free to use. Not open source.
