# 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
Raw data
{
"_id": null,
"home_page": "https://github.com/shipperstack/shipper/tree/master/shippy",
"name": "shipper-shippy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Eric Park",
"author_email": "me@ericswpark.com",
"download_url": "https://files.pythonhosted.org/packages/fc/1d/b26b36a018aba5cfcfc6f6bac579f6bef2888e580a270f09581ab2b8e8db/shipper_shippy-2.42.4.tar.gz",
"platform": null,
"description": "# shippy\n\n[\n\n\n](https://pypi.org/project/shipper-shippy/)\n\nClient-side tool to interface with shipper\n\n# Usage\n\nGet shippy from PyPI:\n\n```shell\npipx install shipper-shippy # pipx, recommended\npip3 install --upgrade shipper-shippy # or pip3\n```\n\nGo to the directory with build files, and run:\n\n```shell\nshippy\n```\n\nRun `shippy -h` to see commandline arguments' usage instructions.\n\n# Configuration\n\nshippy stores its configuration in `~/.shippy.ini`. An example configuration file is shown below:\n\n```ini\n[shippy]\nserver = https://example.com\ntoken = a1b2c3d4e5...\nDisableBuildOnUpload = false\nUploadWithoutPrompt = false\ndebug = false\n```\n\nConfiguration options explained:\n\n### `server`\n\nServer URL\n\n### `token`\n\nToken used to sign in to the server\n\n### `DisableBuildOnUpload`\n\nImmediately disables the build after uploading it. Useful if you are uploading from Jenkins or uploading potentially\nunstable builds. Do NOT use under normal circumstances!\n\n### `UploadWithoutPrompt`\n\nshippy will not prompt you before uploading builds, and will automatically upload all builds found in the current\ndirectory. Use with caution. Same as the `-y`/`--yes` flag shown above.\n\n### `debug`\n\nEnable debug mode for all invocations. When set to true, the `-d`/`--debug` flag will have no effect, and all\ninvocations of shippy will run with debug mode enabled.\n\n\n# Status\n\nshippy returns exit codes based on the results.\n\n`1` - Ctrl-C exit\n\n`2` - one or more builds failed to upload and/or set disabled status\n",
"bugtrack_url": null,
"license": null,
"summary": "Client-side tool to interface with shipper",
"version": "2.42.4",
"project_urls": {
"Bug Tracker": "https://github.com/shipperstack/shipper/issues",
"Homepage": "https://github.com/shipperstack/shipper/tree/master/shippy"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ccaed1db569fa3ac355d6b1219e88a2d230a9f5e06a4a38cd86a04efbd7480ee",
"md5": "cf26c5b484a9f1f0ce745fc382b20e72",
"sha256": "516083fe9969bc681d631e92cf9f2fc4008735fcbb8f6fec53fead4d3b8d5ac4"
},
"downloads": -1,
"filename": "shipper_shippy-2.42.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf26c5b484a9f1f0ce745fc382b20e72",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13384,
"upload_time": "2025-08-20T21:43:12",
"upload_time_iso_8601": "2025-08-20T21:43:12.248868Z",
"url": "https://files.pythonhosted.org/packages/cc/ae/d1db569fa3ac355d6b1219e88a2d230a9f5e06a4a38cd86a04efbd7480ee/shipper_shippy-2.42.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fc1db26b36a018aba5cfcfc6f6bac579f6bef2888e580a270f09581ab2b8e8db",
"md5": "0716b39d07fd240363de3002fceb8af5",
"sha256": "240a9cf04cfc553403761c0b3843bbf7884484ca925e7f9d3f77d2f2d6162f15"
},
"downloads": -1,
"filename": "shipper_shippy-2.42.4.tar.gz",
"has_sig": false,
"md5_digest": "0716b39d07fd240363de3002fceb8af5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11203,
"upload_time": "2025-08-20T21:43:13",
"upload_time_iso_8601": "2025-08-20T21:43:13.580533Z",
"url": "https://files.pythonhosted.org/packages/fc/1d/b26b36a018aba5cfcfc6f6bac579f6bef2888e580a270f09581ab2b8e8db/shipper_shippy-2.42.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-20 21:43:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shipperstack",
"github_project": "shipper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "shipper-shippy"
}
JSON
