# 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/7c/06/a689dbcdc89c3e15c85993126d4c2479d1591d755cba4508d7ebf58e84af/shipper_shippy-2.41.8.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.41.8",
"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": "431435dee2a5b187ebb750a8609a6e3e6634a028d3f49d13bf9ef4a7dd5f703d",
"md5": "277148ab084f108b76c06839674e4b69",
"sha256": "9ebe94e603e6da461f09d0d7f98f1176fbe0f04a6e483d13dee37ec71f428022"
},
"downloads": -1,
"filename": "shipper_shippy-2.41.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "277148ab084f108b76c06839674e4b69",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13452,
"upload_time": "2025-02-21T02:18:03",
"upload_time_iso_8601": "2025-02-21T02:18:03.269180Z",
"url": "https://files.pythonhosted.org/packages/43/14/35dee2a5b187ebb750a8609a6e3e6634a028d3f49d13bf9ef4a7dd5f703d/shipper_shippy-2.41.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7c06a689dbcdc89c3e15c85993126d4c2479d1591d755cba4508d7ebf58e84af",
"md5": "b3815919bdd9b8d209b6ad9f738758a8",
"sha256": "9baac7e36b3909c1d0f1ca25e995432702edb7820a1f72e3cc406ec9752605b6"
},
"downloads": -1,
"filename": "shipper_shippy-2.41.8.tar.gz",
"has_sig": false,
"md5_digest": "b3815919bdd9b8d209b6ad9f738758a8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11268,
"upload_time": "2025-02-21T02:18:05",
"upload_time_iso_8601": "2025-02-21T02:18:05.005356Z",
"url": "https://files.pythonhosted.org/packages/7c/06/a689dbcdc89c3e15c85993126d4c2479d1591d755cba4508d7ebf58e84af/shipper_shippy-2.41.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-21 02:18:05",
"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
