Skip to main content

Python client of Resman

Project description

ResMan Client

Introduction

This is the client of Resman Server.

Use pip install resman-client to install it.

Initialize

from resman_client import ResmanClient

client = ResmanClient(
    "https://resman.xxx.com/",
    "user-name",
    "password"
)

Image List

from resman_client import ImageList, DefaultS3Image, ImageListClient

image_list: ImageListClient = client.create_image_list(
    ImageList(
        title="title",
        description="content",
        data={
            # jsonable object
        }
    )
)

image_list.append_s3_images([
    # DefaultS3Image objects
    # Can be different bucket, but must be same server as Resman Server
])

image_list.upload_images([
    # filenames, binary data or binary IOs
])

Video List

from resman_client import VideoListClient, VideoList

video_list: VideoListClient = client.create_video_list(
    VideoList(
        title="title",
        description="whatever",
        data={
            # jsonable object 
        }
    )
)

# Upload video
video_list.upload_mp4_video(
    "mp4 file path"
)

Novel

from resman_client import NovelClient, Novel

novel: NovelClient = client.create_novel(
    Novel(
        title="title",
        data={
            # jsonable object 
        }
    ),
    text="Content of the novel"
)

Some Notice

  • Support mp4 (h264/h265) video only
  • data is a JSON body to store some metadata like original URL, won't be displayed in website
  • Video and Image list have an attribute order to control the order, auto increasing (+1) will be applied while uploading multi objects, the order of objects with same order field can't be predicted.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

resman-client-1.6.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

resman_client-1.6-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file resman-client-1.6.tar.gz.

File metadata

  • Download URL: resman-client-1.6.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for resman-client-1.6.tar.gz
Algorithm Hash digest
SHA256 dbefacf65310868bbc92bb4fe069f04527ebe05bf41086da0bf7944c23875d52
MD5 69713f0f510dae727423a62ea564ed2a
BLAKE2b-256 7c4ab391b56ec109cc47e7327089e9aabbb355d19c78178aed6d70016071c747

See more details on using hashes here.

File details

Details for the file resman_client-1.6-py3-none-any.whl.

File metadata

  • Download URL: resman_client-1.6-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for resman_client-1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 f9738071ae809c9160c38887b74debb2667bc3e81da3f555fe6eb3afe026a0c9
MD5 bfdce5e5a4c15bec55e875ab45065e85
BLAKE2b-256 390d8c2e46cd03de565a64415e9c3912e515a51a620939f4c668ca76e89a71c1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page