Metadata-Version: 2.4
Name: growtoward
Version: 0.1.1
Summary: Client library for the GrowToward API
Author-email: Jason Twohy <twohy2e@gmail.com>
License-Expression: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx==0.27.0
Requires-Dist: pyotp==2.9.0
Requires-Dist: pyjwt==2.8.0
Requires-Dist: pytz
Requires-Dist: python-dateutil
Requires-Dist: PyYAML>=5.4
Requires-Dist: qrcode==7.4.2
Requires-Dist: rich
Requires-Dist: fire
Dynamic: license-file

# growtoward

## Installation

```bash
pip install growtoward
```

## Release

Run the repo release helper from the repo root. It bumps the patch version by
default, rebuilds artifacts in a throwaway venv, uploads with your PyPI token,
verifies a clean install, and creates a `gtcli-v<version>` git tag:

```bash
PYPI_TOKEN=your-token python3 scripts/release_gtcli.py
```

To bump a different part, pass `minor` or `major`:

```bash
PYPI_TOKEN=your-token python3 scripts/release_gtcli.py minor
```

## Review Diff Since Release

Once releases have been tagged, review the `gtcli` diff from the latest release
with:

```bash
python3 scripts/review_gtcli_diff.py
```

Useful variants:

```bash
python3 scripts/review_gtcli_diff.py --stat
python3 scripts/review_gtcli_diff.py --name-only
```

There are no historical `gtcli-v*` tags in this repo yet, so for the first use
you need to point at the baseline release ref explicitly:

```bash
python3 scripts/review_gtcli_diff.py --against <git-ref>
```

Python client library for interacting with the GrowToward API.

## Windows

Install with the Python launcher so the package lands under the interpreter you
plan to use:

```powershell
py -m pip install growtoward
```

Check where GrowToward's script wrappers were installed:

```powershell
py -m growtoward.gt_path
```

If `gt` is still not recognized, add that interpreter's `Scripts` directory to
your user `PATH`:

```powershell
py -m growtoward.gt_path --add-user-path
```

Then open a new shell and verify:

```powershell
gt --help
```

If you want a fallback that does not depend on `PATH`, you can always run:

```powershell
py -m growtoward.cli --help
```

## macOS and Linux

Install through the interpreter directly so `pip` does not depend on your shell
already exposing a standalone `pip` command:

```bash
python3 -m pip install growtoward
```

Check where GrowToward's script wrappers were installed:

```bash
python3 -m growtoward.gt_path
```

If `gt` is still not recognized, add that interpreter's scripts directory to
your shell startup file automatically:

```bash
python3 -m growtoward.gt_path --add-user-path
```

The helper will print which startup file it touched and how to source it in the
current shell. After opening a new shell, verify:

```bash
gt --help
```

If you want a fallback that does not depend on `PATH`, you can always run:

```bash
python3 -m growtoward.cli --help
```
