Package: insoundz-cli
insoundz-cli PackageA simple CLI which is used to give the client an easy and fast access to insoundz API.InstallationTo enable the auto-complete support, you will have to pip install from source and not from wheel.pip install --no-binary insoundz-cli insoundz-cliOtherwise, you can just run:pip install insoundz-cliNOTE: Please make sure you are running python3.7 or later.HelpCommandDescriptionbalanceGet client balance.configSet or view config variables.enhance-fileEnhance audio file.versionDisplay versions.Command: configSub-commandDescriptiongetEcho config variables.setUpdate config variables.Sub-command: config getArgumentDescriptionRequiredDefaultNoneNoneNoneNoneSub-command: config setArgumentDescriptionRequiredDefault--client-idClient 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.NoneNone--secretSecret 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.NoneNone--urlUse 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.Noneapi.insoundz.ioCommand: enhance-fileArgumentDescriptionRequiredDefault--client-idClient 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 commandNone--secretSecret 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 commandNone--urlUse 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.Noapi.insoundz.io--srcA local path of the original audio file.YesNone--no-downloadIf set, the enhanced file won't be downloaded to the local machine (we'll get only the URL of the enhanced file).NoFalse--dstA local path or file to download the enhanced file.No<current_path>/<original_filename>_enhanced.<original_suffix>--retentionURL Retention duration [minutes].NoNone--status-intervalCheck the enhancement process every <status_interval> [seconds].No0.5--no-progress-barIf set, progress-bar won't be displayed.NoFalseCommand: versionArgumentDescriptionRequiredDefault----------:------------:---------:----------client-idClient 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 commandNone--secretSecret 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 commandNone--urlUse 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.Noapi.insoundz.ioCommand: balanceArgumentDescriptionRequiredDefault--client-idClient 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 commandNone--secretSecret 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 commandNone--urlUse 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.Noapi.insoundz.ioGetting startedinsoundz_cli <command> <arg1> <arg2> ...Example #1:Get versions.insoundz_cli versionExample #2:Permanently set client ID and secret key.insoundz_cli config set --client-id XXXX-XXXX-XXXX-XXXX --secret XXXX-XXXX-XXXX-XXXXExample #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").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").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.insoundz_cli enhance-file --src="/home/example_user/my_audio_files/example.wav" --no-download --retention=480