| Name | streampot JSON |
| Version |
0.3.2
JSON |
| download |
| home_page | None |
| Summary | API client for StreamPot.io |
| upload_time | 2024-06-08 20:40:29 |
| maintainer | None |
| docs_url | None |
| author | Jack Bridger, Ostap Brehin |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/streampot/)
[](https://github.com/StreamPot/python-sdk/actions/workflows/test.yml)
[](https://github.com/StreamPot/python-sdk/releases)
[](https://github.com/StreamPot/python-sdk/blob/main/LICENSE)
## Installation
Install this library using `pip`:
```bash
pip install streampot
```
## Usage
Here's a simple example that converts a video file to an audio file:
```python
from streampot import StreamPot
client = StreamPot(secret='yourToken')
job = client.input('https://download.samplelib.com/mp4/sample-5s.mp4') \
.output('audio.mp3') \
.run_and_wait()
print(job.outputs['audio.mp3'])
```
If you want to run the job in the background, you can use the `run` method:
```python
job = client.input('https://download.samplelib.com/mp4/sample-5s.mp4') \
.output('audio.mp3') \
.run()
```
And fetch the job info using the `get_job` method:
```python
job = client.get_job(job.id)
print(job.status)
print(job.outputs['audio.mp3']) # output url by file name
print(job.logs) # error logs if any
print(job.created_at)
print(job.completed_at)
```
## Development
To contribute to this library, first checkout the code. Then create a new virtual environment:
```bash
cd streampot
python -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
pip install -e '.[test]'
```
To run the tests:
```bash
pytest
```
Raw data
{
"_id": null,
"home_page": null,
"name": "streampot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Jack Bridger, Ostap Brehin",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ec/e1/42c73655a2c2964327105388ca139dd2b9acfdd9e2f27905a6887234e287/streampot-0.3.2.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/streampot/)\n[](https://github.com/StreamPot/python-sdk/actions/workflows/test.yml)\n[](https://github.com/StreamPot/python-sdk/releases)\n[](https://github.com/StreamPot/python-sdk/blob/main/LICENSE)\n\n## Installation\n\nInstall this library using `pip`:\n```bash\npip install streampot\n```\n## Usage\n\nHere's a simple example that converts a video file to an audio file:\n\n```python\nfrom streampot import StreamPot\n\nclient = StreamPot(secret='yourToken')\n\njob = client.input('https://download.samplelib.com/mp4/sample-5s.mp4') \\\n .output('audio.mp3') \\\n .run_and_wait()\n\nprint(job.outputs['audio.mp3'])\n```\n\nIf you want to run the job in the background, you can use the `run` method:\n\n```python\njob = client.input('https://download.samplelib.com/mp4/sample-5s.mp4') \\\n .output('audio.mp3') \\\n .run()\n```\n\nAnd fetch the job info using the `get_job` method:\n\n```python\njob = client.get_job(job.id)\n\nprint(job.status)\nprint(job.outputs['audio.mp3']) # output url by file name\nprint(job.logs) # error logs if any\nprint(job.created_at)\nprint(job.completed_at)\n```\n\n## Development\n\nTo contribute to this library, first checkout the code. Then create a new virtual environment:\n```bash\ncd streampot\npython -m venv venv\nsource venv/bin/activate\n```\nNow install the dependencies and test dependencies:\n```bash\npip install -e '.[test]'\n```\nTo run the tests:\n```bash\npytest\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "API client for StreamPot.io",
"version": "0.3.2",
"project_urls": {
"CI": "https://github.com/StreamPot/python-sdk/actions",
"Changelog": "https://github.com/StreamPot/python-sdk/releases",
"Homepage": "https://github.com/StreamPot/python-sdk",
"Issues": "https://github.com/StreamPot/python-sdk/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b2511cda6ecbf4ebabd1b0e2cec4741be0ab46083eb0026b171d743c394b7b6d",
"md5": "cb53345498c7b3b254f4c33838b88925",
"sha256": "01eb7965e36ad5be5e0a40ca9cc7f994feb9aed2ce4a97752ecc4af7089d1c84"
},
"downloads": -1,
"filename": "streampot-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb53345498c7b3b254f4c33838b88925",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8292,
"upload_time": "2024-06-08T20:40:28",
"upload_time_iso_8601": "2024-06-08T20:40:28.400151Z",
"url": "https://files.pythonhosted.org/packages/b2/51/1cda6ecbf4ebabd1b0e2cec4741be0ab46083eb0026b171d743c394b7b6d/streampot-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ece142c73655a2c2964327105388ca139dd2b9acfdd9e2f27905a6887234e287",
"md5": "e2c812eb4f14caf87f097f8e891df70d",
"sha256": "3a89cb079d2045dbde1e02167dd75a6e787bb76625ba144048c4f6f699a1ca09"
},
"downloads": -1,
"filename": "streampot-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "e2c812eb4f14caf87f097f8e891df70d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8536,
"upload_time": "2024-06-08T20:40:29",
"upload_time_iso_8601": "2024-06-08T20:40:29.658975Z",
"url": "https://files.pythonhosted.org/packages/ec/e1/42c73655a2c2964327105388ca139dd2b9acfdd9e2f27905a6887234e287/streampot-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-08 20:40:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "StreamPot",
"github_project": "python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "streampot"
}
