Metadata-Version: 2.4
Name: shipper-shippy
Version: 2.42.3
Summary: Client-side tool to interface with shipper
Home-page: https://github.com/shipperstack/shipper/tree/master/shippy
Author: Eric Park
Author-email: me@ericswpark.com
Project-URL: Bug Tracker, https://github.com/shipperstack/shipper/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: humanize==4.12.3
Requires-Dist: loguru==0.7.3
Requires-Dist: requests==2.32.4
Requires-Dist: rich==14.1.0
Requires-Dist: semver==3.0.4
Requires-Dist: sentry-sdk==2.34.1
Requires-Dist: setuptools==80.9.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# shippy

[
![PyPI](https://img.shields.io/pypi/v/shipper-shippy)
![PyPI - Downloads](https://img.shields.io/pypi/dm/shipper-shippy)
](https://pypi.org/project/shipper-shippy/)

Client-side tool to interface with shipper

# Usage

Get shippy from PyPI:

```shell
pipx install shipper-shippy             # pipx, recommended
pip3 install --upgrade shipper-shippy   # or pip3
```

Go to the directory with build files, and run:

```shell
shippy
```

Run `shippy -h` to see commandline arguments' usage instructions.

# Configuration

shippy stores its configuration in `~/.shippy.ini`. An example configuration file is shown below:

```ini
[shippy]
server = https://example.com
token = a1b2c3d4e5...
DisableBuildOnUpload = false
UploadWithoutPrompt = false
debug = false
```

Configuration options explained:

### `server`

Server URL

### `token`

Token used to sign in to the server

### `DisableBuildOnUpload`

Immediately disables the build after uploading it. Useful if you are uploading from Jenkins or uploading potentially
unstable builds. Do NOT use under normal circumstances!

### `UploadWithoutPrompt`

shippy will not prompt you before uploading builds, and will automatically upload all builds found in the current
directory. Use with caution. Same as the `-y`/`--yes` flag shown above.

### `debug`

Enable debug mode for all invocations. When set to true, the `-d`/`--debug` flag will have no effect, and all
invocations of shippy will run with debug mode enabled.


# Status

shippy returns exit codes based on the results.

`1` - Ctrl-C exit

`2` - one or more builds failed to upload and/or set disabled status
