Metadata-Version: 2.4
Name: c2client
Version: 0.27
Summary: RockitCloud Platform - API Client
Home-page: https://github.com/c2devel/c2-client
Author: RockitCloud Team
Author-email: devel@k2.cloud
Maintainer: Andrey Kulaev
Maintainer-email: adkulaev@gmail.com
License: GPL3
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: boto3
Requires-Dist: botocore
Requires-Dist: inflection==0.3.1
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: requires-dist
Dynamic: summary

K2 Cloud API Client
=====================

Simple command-line utility for sending custom requests to K2 Cloud platform.

**Warning: this utility is not intended for automation cases.
Use https://github.com/c2devel/boto3.git and python scripts instead.**

Installation
------------

C2client package relies on forked versions of boto3 and botocore from the `C2Devel/boto3 <https://github.com/c2Devel/boto3>`_ and `C2Devel/botocore <https://github.com/c2Devel/botocore>`_ repositories. For isolated use our dependencies, it is highly recommended to use a virtual environment.


1. Clone the repository

    .. code-block:: bash 

       git clone https://github.com/C2Devel/c2-client.git && cd c2-client
       
2. Setup the virtual environment(Unix based system)

    .. code-block:: bash 

       python3 -m venv .venv && source .venv/bin/activate
       
3. Install the package in editable mode along with dependencies from requirements.txt

    .. code-block:: bash

       pip install -e . -r requirements.txt


Usage
-----

.. code-block::

   $ c2-ec2 --help
   usage: c2-ec2 [-h] action [parameters [parameters ...]]

   positional arguments:
      action          The action that you want to perform.
      parameters      Any parameters for the action. Parameters specified by parameter
                      key and parameter value separated by space.

   optional arguments:
      -h, --help      show this help message and exit
      --no-verify-ssl disable verifying ssl certificate


Common request syntax:

.. code-block:: bash

   $ c2-ec2 <action> <arg1> <value1> <arg2> <value2>


Example
-------

Send simple request:

.. code-block:: bash

   $ c2-ec2 RunInstances ImageId cmi-078880A0 Description "Test instance" \
   InstanceType m1.small MaxCount 1 MinCount 1 SecurityGroup.1 test
