insoundz-cli


Nameinsoundz-cli JSON
Version 0.1.19 PyPI version JSON
download
home_pagehttps://github.com/InSoundz/insoundz-api/tree/main/insoundz_cli
SummaryA simple CLI which is used to give the client an easy and fast access to insoundz API.
upload_time2022-11-24 21:12:10
maintainer
docs_urlNone
author
requires_python>=3.7
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1><img align="center" height="90" src="https://drive.google.com/uc?export=view&id=1b1DHDNsl_XGjtU_AK1QR9q_lSo3iLQ4x"> &nbsp; insoundz-cli Package</h1>
A simple CLI which is used to give the client an easy and fast access to insoundz API.
<br />
<br />

![PyPI](https://img.shields.io/pypi/v/insoundz-cli)
![PyPI - License](https://img.shields.io/pypi/l/insoundz-cli)
![PyPI - OS](https://img.shields.io/badge/Operating%20System-OS%20Independent-green)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/insoundz-cli)

## Installation
Please make sure you are running python3.7 or later.
```console
pip install insoundz-cli
```

## Help
| Command       | Description                   |
|---------------|:------------------------------|
| balance       | Get client balance.           |
| config        | Set or view config variables. |
| enhance-file  | Enhance audio file.           |
| version       | Display versions.             |

### Command: config

| Sub-command | Description              |
|-------------|:-------------------------|
| get         | Echo config variables.   |
| set         | Update config variables. |

### Sub-command: config get

| Argument | Description | Required | Default |
|--------- |:------------|:---------|:--------|
| None     | None        | None     | None    |

### Sub-command: config set

| Argument    | Description | Required | Default |
|-------------|:------------|:---------|:--------|
| --client-id | Client ID for insoundz API services. If not set, the CLI uses the permanently configured client ID. If set, the CLI will use this client ID only for this session. | None | None |
| --secret    | Secret key to access insoundz API services. If not set, the CLI uses the permanently configured secret key. If set, the CLI will use this secret key only for this session. | None | None |
| --url       | Use an alternative endpoint URL (without the 'http://' prefix). If not set, the CLI uses the permanently configured url. If set, the CLI will use this url only for this session. If not set and not permanently configured, the CLI will use the default url. | None | api.insoundz.io |

### Command: enhance-file 

| Argument        | Description | Required | Default |
|-----------------|:------------|:---------|:--------|
| --client-id       | Client ID for insoundz API services. If not set, the CLI uses the permanently configured client ID. If set, the CLI will use this client ID only for this session. | If not set with config command | None |
| --secret          | Secret key to access insoundz API services. If not set, the CLI uses the permanently configured secret key. If set, the CLI will use this secret key only for this session. | If not set with config command | None |
| --url             | Use an alternative endpoint URL (without the 'http://' prefix). If not set, the CLI uses the permanently configured url. If set, the CLI will use this url only for this session. If not set and not permanently configured, the CLI will use the default url. | No | api.insoundz.io |
| --src             | A local path of the original audio file. | Yes | None |
| --no-download     | If set, the enhanced file won't be downloaded to the local machine (we'll get only the URL of the enhanced file). | No | False|
| --dst             | A local path or file to download the enhanced file. | No | <current_path>/<original_filename>_enhanced.<original_suffix> |
| --retention       | URL Retention duration [minutes]. | No | None |
| --status-interval | Check the enhancement process every <status_interval> [seconds]. | No | 0.5 |
| --no-progress-bar | If set, progress-bar won't be displayed. | No | False |

### Command: version 

| Argument | Description | Required | Default |
|----------|:------------|:---------|:--------|
| None     | None        | None     | None    |

### Command: balance 

| Argument | Description | Required | Default |
|----------|:------------|:---------|:--------|
| --client-id       | Client ID for insoundz API services. If not set, the CLI uses the permanently configured client ID. If set, the CLI will use this client ID. | If not set with config command | None |
| --secret          | Secret key to access insoundz API services. If not set, the CLI uses the permanently configured secret key. If set, the CLI will use this secret key. | If not set with config command | None |
| --url             | Use an alternative endpoint URL (without the 'http://' prefix). If not set, the CLI uses the permanently configured url. If set, the CLI will use this url. If not set and not permanently configured, the CLI will use the default url. | No | api.insoundz.io |

## Getting started
```console
insoundz_cli <command> <arg1> <arg2> ...
```

### Example #1:
Get versions.
```console
insoundz_cli version
```

### Example #2:
Permanently set client ID and secret key.
```console
insoundz_cli config set --client-id XXXX-XXXX-XXXX-XXXX --secret XXXX-XXXX-XXXX-XXXX
```

### Example #3:
Upload an audio file from our local machine and at the end of the audio enhancement process download the enhanced file to our local machine (to "<current_path>/example_enhanced.wav").
```console
insoundz_cli enhance-file --src="/home/example_user/my_audio_files/example.wav"
```

### Example #4:
Upload an audio file from our local machine and at the end of the audio enhancement process download the enhanced file to our local machine (to "/home/example_user/my_enhanced_files_dir/new_file.wav").
```console
insoundz_cli enhance-file --src="/home/example_user/my_audio_files/example.wav" --dst="/home/example_user/my_enhanced_files_dir/new_file.wav
```

### Example #5:
Upload an audio file from our local machine and at the end of the audio enhancement process don't download the enhanced files and request to keep the URL of the enhanced file valid for 8 hours.
```console
insoundz_cli enhance-file --src="/home/example_user/my_audio_files/example.wav" --no-download --retention=480
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/InSoundz/insoundz-api/tree/main/insoundz_cli",
    "name": "insoundz-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/21/38/cf67c3b4f2403feabfb6ee712456e8428d131181b74b6f99ede7e7c6fb3e/insoundz_cli-0.1.19.tar.gz",
    "platform": null,
    "description": "<h1><img align=\"center\" height=\"90\" src=\"https://drive.google.com/uc?export=view&id=1b1DHDNsl_XGjtU_AK1QR9q_lSo3iLQ4x\"> &nbsp; insoundz-cli Package</h1>\nA simple CLI which is used to give the client an easy and fast access to insoundz API.\n<br />\n<br />\n\n![PyPI](https://img.shields.io/pypi/v/insoundz-cli)\n![PyPI - License](https://img.shields.io/pypi/l/insoundz-cli)\n![PyPI - OS](https://img.shields.io/badge/Operating%20System-OS%20Independent-green)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/insoundz-cli)\n\n## Installation\nPlease make sure you are running\u00a0python3.7 or later.\n```console\npip install insoundz-cli\n```\n\n## Help\n| Command       | Description                   |\n|---------------|:------------------------------|\n| balance       | Get client balance.           |\n| config        | Set or view config variables. |\n| enhance-file  | Enhance audio file.           |\n| version       | Display versions.             |\n\n### Command: config\n\n| Sub-command | Description              |\n|-------------|:-------------------------|\n| get         | Echo config variables.   |\n| set         | Update config variables. |\n\n### Sub-command: config get\n\n| Argument | Description | Required | Default |\n|--------- |:------------|:---------|:--------|\n| None     | None        | None     | None    |\n\n### Sub-command: config set\n\n| Argument    | Description | Required | Default |\n|-------------|:------------|:---------|:--------|\n| --client-id | Client ID for insoundz API services. If not set, the CLI uses the permanently configured client ID. If set, the CLI will use this client ID only for this session. | None | None |\n| --secret    | Secret key to access insoundz API services. If not set, the CLI uses the permanently configured secret key. If set, the CLI will use this secret key only for this session. | None | None |\n| --url       | Use an alternative endpoint URL (without the 'http://' prefix). If not set, the CLI uses the permanently configured url. If set, the CLI will use this url only for this session. If not set and not permanently configured, the CLI will use the default url. | None | api.insoundz.io |\n\n### Command: enhance-file \n\n| Argument        | Description | Required | Default |\n|-----------------|:------------|:---------|:--------|\n| --client-id       | Client ID for insoundz API services. If not set, the CLI uses the permanently configured client ID. If set, the CLI will use this client ID only for this session. | If not set with config command | None |\n| --secret          | Secret key to access insoundz API services. If not set, the CLI uses the permanently configured secret key. If set, the CLI will use this secret key only for this session. | If not set with config command | None |\n| --url             | Use an alternative endpoint URL (without the 'http://' prefix). If not set, the CLI uses the permanently configured url. If set, the CLI will use this url only for this session. If not set and not permanently configured, the CLI will use the default url. | No | api.insoundz.io |\n| --src             | A local path of the original audio file. | Yes | None |\n| --no-download     | If set, the enhanced file won't be downloaded to the local machine (we'll get only the URL of the enhanced file). | No | False|\n| --dst             | A local path or file to download the enhanced file. | No | <current_path>/<original_filename>_enhanced.<original_suffix> |\n| --retention       | URL Retention duration [minutes]. | No | None |\n| --status-interval | Check the enhancement process every <status_interval> [seconds]. | No | 0.5 |\n| --no-progress-bar | If set, progress-bar won't be displayed. | No | False |\n\n### Command: version \n\n| Argument | Description | Required | Default |\n|----------|:------------|:---------|:--------|\n| None     | None        | None     | None    |\n\n### Command: balance \n\n| Argument | Description | Required | Default |\n|----------|:------------|:---------|:--------|\n| --client-id       | Client ID for insoundz API services. If not set, the CLI uses the permanently configured client ID. If set, the CLI will use this client ID. | If not set with config command | None |\n| --secret          | Secret key to access insoundz API services. If not set, the CLI uses the permanently configured secret key. If set, the CLI will use this secret key. | If not set with config command | None |\n| --url             | Use an alternative endpoint URL (without the 'http://' prefix). If not set, the CLI uses the permanently configured url. If set, the CLI will use this url. If not set and not permanently configured, the CLI will use the default url. | No | api.insoundz.io |\n\n## Getting started\n```console\ninsoundz_cli <command> <arg1> <arg2> ...\n```\n\n### Example #1:\nGet versions.\n```console\ninsoundz_cli version\n```\n\n### Example #2:\nPermanently set client ID and secret key.\n```console\ninsoundz_cli config set --client-id XXXX-XXXX-XXXX-XXXX --secret XXXX-XXXX-XXXX-XXXX\n```\n\n### Example #3:\nUpload an audio file from our local machine and at the end of the audio enhancement process download the enhanced file to our local machine (to \"<current_path>/example_enhanced.wav\").\n```console\ninsoundz_cli enhance-file --src=\"/home/example_user/my_audio_files/example.wav\"\n```\n\n### Example #4:\nUpload an audio file from our local machine and at the end of the audio enhancement process download the enhanced file to our local machine (to \"/home/example_user/my_enhanced_files_dir/new_file.wav\").\n```console\ninsoundz_cli enhance-file --src=\"/home/example_user/my_audio_files/example.wav\" --dst=\"/home/example_user/my_enhanced_files_dir/new_file.wav\n```\n\n### Example #5:\nUpload an audio file from our local machine and at the end of the audio enhancement process don't download the enhanced files and request to keep the URL of the enhanced file valid for 8 hours.\n```console\ninsoundz_cli enhance-file --src=\"/home/example_user/my_audio_files/example.wav\" --no-download --retention=480\n```\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A simple CLI which is used to give the client an easy         and fast access to insoundz API.",
    "version": "0.1.19",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "dd07045f7730c2980f55244796ba77a1",
                "sha256": "e318176a48bfb1e6b6390cf836107ef47f9fac6d436d4f683f0713711596cc19"
            },
            "downloads": -1,
            "filename": "insoundz_cli-0.1.19.tar.gz",
            "has_sig": false,
            "md5_digest": "dd07045f7730c2980f55244796ba77a1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 5133,
            "upload_time": "2022-11-24T21:12:10",
            "upload_time_iso_8601": "2022-11-24T21:12:10.279967Z",
            "url": "https://files.pythonhosted.org/packages/21/38/cf67c3b4f2403feabfb6ee712456e8428d131181b74b6f99ede7e7c6fb3e/insoundz_cli-0.1.19.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-11-24 21:12:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "insoundz-cli"
}
        
Elapsed time: 0.02987s