shipper-shippy


Nameshipper-shippy JSON
Version 1.5.1 PyPI version JSON
download
home_pagehttps://github.com/ericswpark/shippy
SummaryClient-side tool to interface with shipper
upload_time2021-07-11 08:19:28
maintainer
docs_urlNone
authorEric Park
requires_python>=3.5
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # shippy
![version](https://img.shields.io/github/v/release/ericswpark/shippy)
![commits-since](https://img.shields.io/github/commits-since/ericswpark/shippy/latest)
[
![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
pip3 install shipper-shippy
```

Go to the directory with build files, and run:

```shell
shippy
```

Command-line arguments:

```shell
usage: __main__.py [-h] [-y]

Client-side tool for interfacing with shipper

optional arguments:
  -h, --help  show this help message and exit
  -y, --yes   Upload builds automatically without prompting
```

# 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
```

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.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ericswpark/shippy",
    "name": "shipper-shippy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": "",
    "keywords": "",
    "author": "Eric Park",
    "author_email": "me@ericswpark.com",
    "download_url": "https://files.pythonhosted.org/packages/7a/82/c09bdcd167838fd9f9f3e761dfb82999aa4570dfcba3f7488b34ed609639/shipper-shippy-1.5.1.tar.gz",
    "platform": "",
    "description": "# shippy\n![version](https://img.shields.io/github/v/release/ericswpark/shippy)\n![commits-since](https://img.shields.io/github/commits-since/ericswpark/shippy/latest)\n[\n![PyPI](https://img.shields.io/pypi/v/shipper-shippy)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/shipper-shippy)\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 shipper-shippy\n```\n\nGo to the directory with build files, and run:\n\n```shell\nshippy\n```\n\nCommand-line arguments:\n\n```shell\nusage: __main__.py [-h] [-y]\n\nClient-side tool for interfacing with shipper\n\noptional arguments:\n  -h, --help  show this help message and exit\n  -y, --yes   Upload builds automatically without prompting\n```\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\n```\n\nConfiguration options explained:\n\n### `server`\nServer URL\n\n### `token`\nToken used to sign in to the server\n\n### `DisableBuildOnUpload`\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`\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\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Client-side tool to interface with shipper",
    "version": "1.5.1",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "77518dac7ffddda9b972cf4d7968c7f6",
                "sha256": "9f38b1ccb8836a0280c86b08bd710e490642ae49de8de3b9cf53a1c66aeec3a5"
            },
            "downloads": -1,
            "filename": "shipper_shippy-1.5.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "77518dac7ffddda9b972cf4d7968c7f6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 11138,
            "upload_time": "2021-07-11T08:19:27",
            "upload_time_iso_8601": "2021-07-11T08:19:27.770865Z",
            "url": "https://files.pythonhosted.org/packages/34/9e/c629c5c61a03dee65dce25acddd26e0450a22ccbb204bdd6bee2fb2e450b/shipper_shippy-1.5.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "79ac64f337eee3126f57e3c48d2bc554",
                "sha256": "f910169b660c4a8b14f9956685c49a0de8b44f2680a22276d10f59aeeab28ff0"
            },
            "downloads": -1,
            "filename": "shipper-shippy-1.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "79ac64f337eee3126f57e3c48d2bc554",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 9400,
            "upload_time": "2021-07-11T08:19:28",
            "upload_time_iso_8601": "2021-07-11T08:19:28.896603Z",
            "url": "https://files.pythonhosted.org/packages/7a/82/c09bdcd167838fd9f9f3e761dfb82999aa4570dfcba3f7488b34ed609639/shipper-shippy-1.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-07-11 08:19:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "ericswpark",
    "github_project": "shippy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "shipper-shippy"
}
        
Elapsed time: 0.28055s