# shippy
[
](https://pypi.org/project/shipper-shippy/)
Client-side tool to interface with shipper
# Usage
Get shippy from PyPI:
```shell
pip3 install --upgrade shipper-shippy
```
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/ericswpark/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/e5/18/5e9bc514e9705589d04aa3a81766744597bfc98e5eed71d962571c5805d2/shipper_shippy-2.35.0.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\npip3 install --upgrade shipper-shippy\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",
"bugtrack_url": null,
"license": null,
"summary": "Client-side tool to interface with shipper",
"version": "2.35.0",
"project_urls": {
"Bug Tracker": "https://github.com/ericswpark/shippy/issues",
"Homepage": "https://github.com/ericswpark/shippy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4eed47bee6a0ec8ee8eeee11a5f1fc30f4157cbe06b849d4349969e928af4d5",
"md5": "32ede8e1922488e1592c07f15c5f4ffd",
"sha256": "f96927a3ca54238b66af9af8bb62eb3048cacb0cbe4c23b3f8e856cd92189ee2"
},
"downloads": -1,
"filename": "shipper_shippy-2.35.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "32ede8e1922488e1592c07f15c5f4ffd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13022,
"upload_time": "2024-04-20T02:21:27",
"upload_time_iso_8601": "2024-04-20T02:21:27.760545Z",
"url": "https://files.pythonhosted.org/packages/f4/ee/d47bee6a0ec8ee8eeee11a5f1fc30f4157cbe06b849d4349969e928af4d5/shipper_shippy-2.35.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5185e9bc514e9705589d04aa3a81766744597bfc98e5eed71d962571c5805d2",
"md5": "c51c20715eeada3cb55c8e30f89c3a3b",
"sha256": "2a532aef5ca069c9243b5c42eba8821434d9966af5b2f3c83b14c506ceb91496"
},
"downloads": -1,
"filename": "shipper_shippy-2.35.0.tar.gz",
"has_sig": false,
"md5_digest": "c51c20715eeada3cb55c8e30f89c3a3b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10791,
"upload_time": "2024-04-20T02:21:30",
"upload_time_iso_8601": "2024-04-20T02:21:30.135153Z",
"url": "https://files.pythonhosted.org/packages/e5/18/5e9bc514e9705589d04aa3a81766744597bfc98e5eed71d962571c5805d2/shipper_shippy-2.35.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-20 02:21:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ericswpark",
"github_project": "shippy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "humanize",
"specs": [
[
"==",
"4.7.0"
]
]
},
{
"name": "loguru",
"specs": [
[
"==",
"0.7.0"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"13.4.2"
]
]
},
{
"name": "semver",
"specs": [
[
"==",
"3.0.1"
]
]
},
{
"name": "sentry-sdk",
"specs": [
[
"==",
"1.28.1"
]
]
},
{
"name": "setuptools",
"specs": [
[
"==",
"68.0.0"
]
]
}
],
"lcname": "shipper-shippy"
}
JSON
