move-ugc-python


Namemove-ugc-python JSON
Version 2.0.0 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2025-02-12 14:01:04
maintainerNone
docs_urlNone
authorMove.ai
requires_python<4.0.0,>=3.8.1
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Move UGC Python SDK

[![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-7F00FF.svg)](https://github.com/wemake-services/wemake-python-styleguide)
![Python version](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
![Tests](https://github.com/move-ai/move-ugc-python/blob/main/badges/tests.svg)
![Coverage](https://github.com/move-ai/move-ugc-python/blob/main/badges/coverage.svg)
[![CI](https://github.com/move-ai/move-ugc-python/actions/workflows/ci.yml/badge.svg)](https://github.com/move-ai/move-ugc-python/actions/workflows/ci.yml)
![Documentation Style](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)

## Full documentation

The full documentation is available at https://move-ai.github.io/move-ugc-python/latest/

## Installation

### With pip:

```bash
pip install move-ugc-python
```
### With poetry:

```bash
poetry add move-ugc-python
```


## Initialize with your API key

```python
from move_ugc import MoveUgc
ugc = MoveUgc(api_key='<API_KEY>')
```

## Create a file and upload to move.ai

```python
video_file = ugc.files.create(file_type="mp4")
depth_file = ugc.files.create(file_type="move")

presigned_url = video_file['presigned_url'] 
filename = "<path to file on disk>"
with open(filename, 'rb') as f:
    requests.put(presigned_url, data=f.read())
    
presigned_url = depth_file['presigned_url'] 
filename = "<path to file on disk>"
with open(filename, 'rb') as f:
    requests.put(presigned_url, data=f.read())

```

## Retrieve a file

```python
video_file = ugc.files.retrieve(file_id="<FILE_ID>")
```


## Create a take

```python
    take = ugc.takes.create_singlecam(
        sources=[
            SourceIn(
                device_label="my-device",
                file_id=video_file.id,
                format=video_file.type
    )])
    ugc.jobs.create_singlecam(take_id=take.id)
```

## Create a job
    
```python
    job = ugc.jobs.create_singlecam(take_id=take.id)
```


## Contribution Guide

Information for how someone can contribute to this project can be found in our [documentation](https://move-ai.github.io/move-ugc-python/latest/contributing)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "move-ugc-python",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0.0,>=3.8.1",
    "maintainer_email": null,
    "keywords": null,
    "author": "Move.ai",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/aa/fb/f95bb36d17ab7294fa97d3fdb889509679778ac95c6bfb4e779b41de14b6/move_ugc_python-2.0.0.tar.gz",
    "platform": null,
    "description": "# Move UGC Python SDK\n\n[![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-7F00FF.svg)](https://github.com/wemake-services/wemake-python-styleguide)\n![Python version](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)\n![Tests](https://github.com/move-ai/move-ugc-python/blob/main/badges/tests.svg)\n![Coverage](https://github.com/move-ai/move-ugc-python/blob/main/badges/coverage.svg)\n[![CI](https://github.com/move-ai/move-ugc-python/actions/workflows/ci.yml/badge.svg)](https://github.com/move-ai/move-ugc-python/actions/workflows/ci.yml)\n![Documentation Style](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)\n\n## Full documentation\n\nThe full documentation is available at https://move-ai.github.io/move-ugc-python/latest/\n\n## Installation\n\n### With pip:\n\n```bash\npip install move-ugc-python\n```\n### With poetry:\n\n```bash\npoetry add move-ugc-python\n```\n\n\n## Initialize with your API key\n\n```python\nfrom move_ugc import MoveUgc\nugc = MoveUgc(api_key='<API_KEY>')\n```\n\n## Create a file and upload to move.ai\n\n```python\nvideo_file = ugc.files.create(file_type=\"mp4\")\ndepth_file = ugc.files.create(file_type=\"move\")\n\npresigned_url = video_file['presigned_url'] \nfilename = \"<path to file on disk>\"\nwith open(filename, 'rb') as f:\n    requests.put(presigned_url, data=f.read())\n    \npresigned_url = depth_file['presigned_url'] \nfilename = \"<path to file on disk>\"\nwith open(filename, 'rb') as f:\n    requests.put(presigned_url, data=f.read())\n\n```\n\n## Retrieve a file\n\n```python\nvideo_file = ugc.files.retrieve(file_id=\"<FILE_ID>\")\n```\n\n\n## Create a take\n\n```python\n    take = ugc.takes.create_singlecam(\n        sources=[\n            SourceIn(\n                device_label=\"my-device\",\n                file_id=video_file.id,\n                format=video_file.type\n    )])\n    ugc.jobs.create_singlecam(take_id=take.id)\n```\n\n## Create a job\n    \n```python\n    job = ugc.jobs.create_singlecam(take_id=take.id)\n```\n\n\n## Contribution Guide\n\nInformation for how someone can contribute to this project can be found in our [documentation](https://move-ai.github.io/move-ugc-python/latest/contributing)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": null,
    "version": "2.0.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "08fd4fbd029c7e7d1b15b38510350b2060942291c19aac2541b542a8d19e2f9b",
                "md5": "0390a13386f275979d2e9ac8cbca6270",
                "sha256": "98696fec41c44a4eda144af59a75b90280ebc7e44be04764916affe9fa164254"
            },
            "downloads": -1,
            "filename": "move_ugc_python-2.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0390a13386f275979d2e9ac8cbca6270",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0.0,>=3.8.1",
            "size": 32560,
            "upload_time": "2025-02-12T14:01:03",
            "upload_time_iso_8601": "2025-02-12T14:01:03.152349Z",
            "url": "https://files.pythonhosted.org/packages/08/fd/4fbd029c7e7d1b15b38510350b2060942291c19aac2541b542a8d19e2f9b/move_ugc_python-2.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "aafbf95bb36d17ab7294fa97d3fdb889509679778ac95c6bfb4e779b41de14b6",
                "md5": "c2654a8ec02103bd5de352a551444cb2",
                "sha256": "c8a3e9d7729f771ff0e038be9e0b2586891742f249f4645a739417f0a16783b5"
            },
            "downloads": -1,
            "filename": "move_ugc_python-2.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c2654a8ec02103bd5de352a551444cb2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0.0,>=3.8.1",
            "size": 16952,
            "upload_time": "2025-02-12T14:01:04",
            "upload_time_iso_8601": "2025-02-12T14:01:04.708501Z",
            "url": "https://files.pythonhosted.org/packages/aa/fb/f95bb36d17ab7294fa97d3fdb889509679778ac95c6bfb4e779b41de14b6/move_ugc_python-2.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-12 14:01:04",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "move-ugc-python"
}
        
Elapsed time: 0.43318s