connect-cli


Nameconnect-cli JSON
Version 26.14 PyPI version JSON
download
home_pagehttps://connect.cloudblue.com
SummaryCloudBlue Connect Command Line Interface
upload_time2023-01-26 11:10:47
maintainer
docs_urlNone
authorCloudBlue LLC
requires_python>=3.8,<4
licenseApache-2.0
keywords fulfillment command line interface utility cli vendor connect cloudblue
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # CloudBlue Connect Command Line Interface

![pyversions](https://img.shields.io/pypi/pyversions/connect-cli.svg) [![PyPi Status](https://img.shields.io/pypi/v/connect-cli.svg)](https://pypi.org/project/connect-cli/) ![PyPI - Downloads](https://img.shields.io/pypi/dm/connect-cli) ![Docker Pulls](https://img.shields.io/docker/pulls/cloudblueconnect/connect-cli) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/cloudblue/connect-cli/Build%20Connect%20Command%20Line%20Client) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=connect-cli&metric=coverage)](https://sonarcloud.io/summary/new_code?id=connect-cli) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=connect-cli&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=connect-cli)

## Introduction

The CloudBlue Connect Command Line Interface (CLI) is an extensible unified tool to perform various automation scenarios. With just one tool, you can control multiple Connect modules from the command line and automate them through scripts.

Since it is extensible, users can write their own plugins to extend its functionalities.


## Install

### Prerequisites

`connect-cli` depends on [Git](https://git-scm.com/), [Cairo](https://www.cairographics.org/),
[Pango](https://pango.gnome.org/) and [GDK-PixBuf](https://developer.gnome.org/gdk-pixbuf/stable/).

Please refers to the platform-specific instructions on how to install these dependecies:

* [Linux](docs/linux_deps_install.md)
* [Mac OS](docs/osx_deps_install.md)
* [Windows](docs/win_deps_install.md)


### Using PIP

To use `connect-cli` you need a system with python 3.8 or later installed.

```sh
    $ pip install --upgrade connect-cli
```

### Using Docker

To use the Docker image of `connect-cli`:

```sh
    $ docker run -it -v $HOME/.ccli:/home/connect/.ccli cloudblueconnect/connect-cli ccli
```

Please refer to the [`connect-cli` docker image documentation](https://hub.docker.com/r/cloudblueconnect/connect-cli) for more information.


### Using Homebrew on Mac OS

To install `connect-cli` with homebrew run:

```sh
    $ brew update
    $ brew tap cloudblue/connect
    $ brew install cloudblue/connect/connect-cli
```

### Using the installer on Windows

An installer package is available for Windows 10 or newer.
You can download its zip file from the [Github Releases](https://github.com/cloudblue/connect-cli/releases) page.



## Usage

* [General](docs/core_usage.md)
* [Locales](docs/locales_usage.md)
* [Products](docs/products_usage.md)
* [Customers](docs/customers_usage.md)
* [Reports](docs/reports_usage.md)
* [Translations](docs/translations_usage.md)
* [Projects](docs/project_usage.md)


## Run tests

`connect-cli` uses [poetry](https://python-poetry.org/) for dependencies management and packaging.

To run the `connect-cli` tests suite run:

```
$ pip install poetry
$ poetry install
$ poetry run pytest
```


## License

`connect-cli` is released under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

            

Raw data

            {
    "_id": null,
    "home_page": "https://connect.cloudblue.com",
    "name": "connect-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4",
    "maintainer_email": "",
    "keywords": "fulfillment,command,line,interface,utility,cli,vendor,connect,cloudblue",
    "author": "CloudBlue LLC",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/31/1d/00d6403ebec71c6620c342be908437334a9a765aeceafcd327dc3eec025f/connect_cli-26.14.tar.gz",
    "platform": null,
    "description": "# CloudBlue Connect Command Line Interface\n\n![pyversions](https://img.shields.io/pypi/pyversions/connect-cli.svg) [![PyPi Status](https://img.shields.io/pypi/v/connect-cli.svg)](https://pypi.org/project/connect-cli/) ![PyPI - Downloads](https://img.shields.io/pypi/dm/connect-cli) ![Docker Pulls](https://img.shields.io/docker/pulls/cloudblueconnect/connect-cli) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/cloudblue/connect-cli/Build%20Connect%20Command%20Line%20Client) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=connect-cli&metric=coverage)](https://sonarcloud.io/summary/new_code?id=connect-cli) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=connect-cli&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=connect-cli)\n\n## Introduction\n\nThe CloudBlue Connect Command Line Interface (CLI) is an extensible unified tool to perform various automation scenarios. With just one tool, you can control multiple Connect modules from the command line and automate them through scripts.\n\nSince it is extensible, users can write their own plugins to extend its functionalities.\n\n\n## Install\n\n### Prerequisites\n\n`connect-cli` depends on [Git](https://git-scm.com/), [Cairo](https://www.cairographics.org/),\n[Pango](https://pango.gnome.org/) and [GDK-PixBuf](https://developer.gnome.org/gdk-pixbuf/stable/).\n\nPlease refers to the platform-specific instructions on how to install these dependecies:\n\n* [Linux](docs/linux_deps_install.md)\n* [Mac OS](docs/osx_deps_install.md)\n* [Windows](docs/win_deps_install.md)\n\n\n### Using PIP\n\nTo use `connect-cli` you need a system with python 3.8 or later installed.\n\n```sh\n    $ pip install --upgrade connect-cli\n```\n\n### Using Docker\n\nTo use the Docker image of `connect-cli`:\n\n```sh\n    $ docker run -it -v $HOME/.ccli:/home/connect/.ccli cloudblueconnect/connect-cli ccli\n```\n\nPlease refer to the [`connect-cli` docker image documentation](https://hub.docker.com/r/cloudblueconnect/connect-cli) for more information.\n\n\n### Using Homebrew on Mac OS\n\nTo install `connect-cli` with homebrew run:\n\n```sh\n    $ brew update\n    $ brew tap cloudblue/connect\n    $ brew install cloudblue/connect/connect-cli\n```\n\n### Using the installer on Windows\n\nAn installer package is available for Windows 10 or newer.\nYou can download its zip file from the [Github Releases](https://github.com/cloudblue/connect-cli/releases) page.\n\n\n\n## Usage\n\n* [General](docs/core_usage.md)\n* [Locales](docs/locales_usage.md)\n* [Products](docs/products_usage.md)\n* [Customers](docs/customers_usage.md)\n* [Reports](docs/reports_usage.md)\n* [Translations](docs/translations_usage.md)\n* [Projects](docs/project_usage.md)\n\n\n## Run tests\n\n`connect-cli` uses [poetry](https://python-poetry.org/) for dependencies management and packaging.\n\nTo run the `connect-cli` tests suite run:\n\n```\n$ pip install poetry\n$ poetry install\n$ poetry run pytest\n```\n\n\n## License\n\n`connect-cli` is released under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "CloudBlue Connect Command Line Interface",
    "version": "26.14",
    "split_keywords": [
        "fulfillment",
        "command",
        "line",
        "interface",
        "utility",
        "cli",
        "vendor",
        "connect",
        "cloudblue"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b46537e506fefb322067dd007db7d58401a4063722b25f844c0183ef29670644",
                "md5": "82340ee117fe413b15d2b0c846f669cb",
                "sha256": "c8f464d400fa62cfa03c907ac121cfcd1b6874cad553af99a8d4eef559cf88db"
            },
            "downloads": -1,
            "filename": "connect_cli-26.14-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "82340ee117fe413b15d2b0c846f669cb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4",
            "size": 1268806,
            "upload_time": "2023-01-26T11:10:46",
            "upload_time_iso_8601": "2023-01-26T11:10:46.091026Z",
            "url": "https://files.pythonhosted.org/packages/b4/65/37e506fefb322067dd007db7d58401a4063722b25f844c0183ef29670644/connect_cli-26.14-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "311d00d6403ebec71c6620c342be908437334a9a765aeceafcd327dc3eec025f",
                "md5": "ecdc3b4c28d7f98265960568d1424be5",
                "sha256": "acb894cd87c5d59b0d8698e4f97ec8bfc174465c1353f4da06c4223d135791e9"
            },
            "downloads": -1,
            "filename": "connect_cli-26.14.tar.gz",
            "has_sig": false,
            "md5_digest": "ecdc3b4c28d7f98265960568d1424be5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4",
            "size": 1128304,
            "upload_time": "2023-01-26T11:10:47",
            "upload_time_iso_8601": "2023-01-26T11:10:47.573168Z",
            "url": "https://files.pythonhosted.org/packages/31/1d/00d6403ebec71c6620c342be908437334a9a765aeceafcd327dc3eec025f/connect_cli-26.14.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-26 11:10:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "connect-cli"
}
        
Elapsed time: 0.09919s