Metadata-Version: 2.5
Name: watershipup
Version: 0.2.0
Summary: Uploads static websites to Bunny Storage zones
Project-URL: Issues, https://github.com/cariad/watershipup/issues
Project-URL: Source, https://github.com/cariad/watershipup
Author-email: Cariad Eccleston <cariad@cariad.earth>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Typing :: Typed
Requires-Python: >=3.14
Requires-Dist: httpx2<3,>=2.13.1
Requires-Dist: mosey<0.6,>=0.5.0
Description-Content-Type: text/markdown

# WatershipUp

`watershipup` is a Python package and command line tool for uploading static websites to [bunny.net] storage zones.

## Requirements

- Python 3.14 or later
- Your own [bunny.net] account

## Installing

```bash
pip install watershipup
```

## Publishing

`watershipup` needs three values:

- The path of the directory to upload.
- The name of the storage zone to upload to.
- The read-write password for that zone.

The directory and zone are passed on the command line, and the password must be set as the `WATERSHIPUP_PASSWORD` environment variable.

```bash
export WATERSHIPUP_PASSWORD="..."
watershipup --zone example-zone site-dir
```

## Dry runs

Add `--dry-run` to see which files a publish would upload or delete:

```bash
watershipup --dry-run --zone example-zone site-dir
```

## Markdown

Add `--output markdown` to print changes as Markdown:

```bash
watershipup --output markdown --zone example-zone site-dir
```

## Exit codes

| Code | Meaning                                          |
| -    | -                                                |
| 0    | The publish or dry run succeeded.                |
| 1    | The publish or dry run failed.                   |
| 2    | An argument or the password is missing or wrong. |

[bunny.net]: https://bunny.net
