# StutterBuddy
This package allows you to interact with the stutterbuddy.ch API and perform a variety of tasks such as uploading files, submitting jobs, and retrieving information about assets and jobs.
To use this package, you will need to have an API key which you can obtain by creating an account on stutterbuddy.ch.
## Installation
```
pip install stutterbuddy
```
## Usage
The main object in the package is the `Stutterbuddy` class, which you can initialize by passing in your API key. This class has several methods that you can use to perform different actions:
- `upload_file(path_to_file, verbose=1, upload_callback=None)`: This method allows you to upload a local file to stutterbuddy. It returns a unique identifier for your uploaded file.
- `submit_job(asset_id, settings=SubmissionSettings(), verbose=1)`: This method allows you to submit a job to the API. You will need to provide the asset id of the file you want to process and can also specify job settings using a `SubmissionSettings` object. It returns a list of job ids.
- `get_all_jobs(verbose=1)`: This method allows you to retrieve a list of all jobs belonging to the user.
- `get_job(job_id, verbose=1)`: This method allows you to retrieve information about a specific job using the job id.
- `get_asset(asset_id, verbose=1)`: This method allows you to retrieve information about a specific asset using the asset id.
For more information and a complete list of available methods, please refer to the documentation on the stutterbuddy.ch website or the inline documentation in the code.
## Features
- Bulk processing and automatized upload of files to stutterbuddy.ch
- submit videos or audio both as links or as files
- retrieve status of jobs
- coming soon: use as CLI tool
Raw data
{
"_id": null,
"home_page": "https://stutterbuddy.ch",
"name": "stutterbuddy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "stutterbuddy video editing automation auto-editor ai machine-learning",
"author": "Jonas Briguet",
"author_email": "briguetjo@yahoo.de",
"download_url": "https://files.pythonhosted.org/packages/e2/fa/1c8e894a0eec426ebd2e14223652d44b73e7702e4a4dcf4b4b1a361d8ced/stutterbuddy-0.2.2.tar.gz",
"platform": null,
"description": "# StutterBuddy\n\nThis package allows you to interact with the stutterbuddy.ch API and perform a variety of tasks such as uploading files, submitting jobs, and retrieving information about assets and jobs.\n\nTo use this package, you will need to have an API key which you can obtain by creating an account on stutterbuddy.ch.\n\n## Installation\n\n```\npip install stutterbuddy\n```\n\n## Usage\n\nThe main object in the package is the `Stutterbuddy` class, which you can initialize by passing in your API key. This class has several methods that you can use to perform different actions:\n\n- `upload_file(path_to_file, verbose=1, upload_callback=None)`: This method allows you to upload a local file to stutterbuddy. It returns a unique identifier for your uploaded file.\n- `submit_job(asset_id, settings=SubmissionSettings(), verbose=1)`: This method allows you to submit a job to the API. You will need to provide the asset id of the file you want to process and can also specify job settings using a `SubmissionSettings` object. It returns a list of job ids.\n- `get_all_jobs(verbose=1)`: This method allows you to retrieve a list of all jobs belonging to the user.\n- `get_job(job_id, verbose=1)`: This method allows you to retrieve information about a specific job using the job id.\n- `get_asset(asset_id, verbose=1)`: This method allows you to retrieve information about a specific asset using the asset id.\n\nFor more information and a complete list of available methods, please refer to the documentation on the stutterbuddy.ch website or the inline documentation in the code.\n\n## Features\n\n- Bulk processing and automatized upload of files to stutterbuddy.ch\n- submit videos or audio both as links or as files\n- retrieve status of jobs\n- coming soon: use as CLI tool\n",
"bugtrack_url": null,
"license": "",
"summary": "Automate video editing with Stutterbuddy",
"version": "0.2.2",
"split_keywords": [
"stutterbuddy",
"video",
"editing",
"automation",
"auto-editor",
"ai",
"machine-learning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f13954cff3b404c8df5b93af334f1e7acb9aee0179a85aa4fc12db724da88aa1",
"md5": "420c54263601a82a7aac59df2b5241ac",
"sha256": "301cd380afd444ec261d79043dab39213ae1a0cd2dfe21e196c70956db5ee1fb"
},
"downloads": -1,
"filename": "stutterbuddy-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "420c54263601a82a7aac59df2b5241ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6655,
"upload_time": "2023-01-05T17:39:13",
"upload_time_iso_8601": "2023-01-05T17:39:13.543511Z",
"url": "https://files.pythonhosted.org/packages/f1/39/54cff3b404c8df5b93af334f1e7acb9aee0179a85aa4fc12db724da88aa1/stutterbuddy-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e2fa1c8e894a0eec426ebd2e14223652d44b73e7702e4a4dcf4b4b1a361d8ced",
"md5": "bd0508fea005029b4a96eb1c43da0ea5",
"sha256": "b6bed05d3e47104621c4c6d0124e6c968d18d115d3182249db8d559e2b4ca26f"
},
"downloads": -1,
"filename": "stutterbuddy-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "bd0508fea005029b4a96eb1c43da0ea5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5804,
"upload_time": "2023-01-05T17:39:16",
"upload_time_iso_8601": "2023-01-05T17:39:16.082897Z",
"url": "https://files.pythonhosted.org/packages/e2/fa/1c8e894a0eec426ebd2e14223652d44b73e7702e4a4dcf4b4b1a361d8ced/stutterbuddy-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-05 17:39:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "stutterbuddy"
}
JSON