Skip to content

About

Official python SDK for ShionStream API

Resources

Readme
Apache-2.0 license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository
BranchesTags

Repository files navigation

shionstream-sdk

Modular anime streaming and metadata API built with Hono on Cloudflare Workers.

This Python package is automatically generated for ShionStream API using OpenAPI specification.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.26.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://gox.my.id

Requirements.

Python 3.10+

Packaging uses standard [project] metadata and [dependency-groups] (PEP 621/735). Install the package with python -m pip install .; install development dependencies with Poetry 2.2 or newer using poetry install, or pip 25.1 or newer using python -m pip install --group dev. The latter installs the group, not the package.

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/shionstream/shionstream-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/shionstream/shionstream-python.git)

Then import the package:

import shionstream_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import shionstream_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import shionstream_sdk
from shionstream_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.gox.my.id
# See configuration.py for a list of all supported configuration parameters.
configuration = shionstream_sdk.Configuration(
    host = "https://api.gox.my.id"
)



# Enter a context with an instance of the API client
with shionstream_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = shionstream_sdk.AnimeApi(api_client)
    page = '1' # str |  (optional) (default to '1')
    limit = '20' # str |  (optional) (default to '20')
    search = 'search_example' # str |  (optional)
    type = 'type_example' # str |  (optional)
    status = 'status_example' # str |  (optional)
    genre = 'genre_example' # str |  (optional)
    season = 'season_example' # str |  (optional)
    year = 'year_example' # str |  (optional)
    sort = 'latest' # str |  (optional) (default to 'latest')

    try:
        # List Anime Catalog
        api_response = api_instance.v1_anime_get(page=page, limit=limit, search=search, type=type, status=status, genre=genre, season=season, year=year, sort=sort)
        print("The response of AnimeApi->v1_anime_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AnimeApi->v1_anime_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.gox.my.id

Class Method HTTP request Description
AnimeApi v1_anime_get GET /v1/anime List Anime Catalog
AnimeApi v1_anime_slug_get GET /v1/anime/{slug} Get Anime Details by Slug
CommentsApi v1_comments_get GET /v1/comments Get Episode Comments
CommentsApi v1_comments_id_like_post POST /v1/comments/{id}/like Like or Dislike Comment
CommentsApi v1_comments_id_report_post POST /v1/comments/{id}/report Report Comment
CommentsApi v1_comments_post POST /v1/comments Create Comment
DashboardApi v1_dashboard_anime_get GET /v1/dashboard/anime Get Administrative Anime List
DashboardApi v1_dashboard_categories_get GET /v1/dashboard/categories Get Category & Genre Distributions
DashboardApi v1_dashboard_episodes_get GET /v1/dashboard/episodes Get Administrative Episodes List
DashboardApi v1_dashboard_moderation_get GET /v1/dashboard/moderation Get Comment Moderation Reports
DashboardApi v1_dashboard_moderation_id_patch PATCH /v1/dashboard/moderation/{id} Resolve or Dismiss Moderation Report
DashboardApi v1_dashboard_overview_get GET /v1/dashboard/overview Get Dashboard Overview
DashboardApi v1_dashboard_roles_get GET /v1/dashboard/roles Get System Roles & Permissions
DashboardApi v1_dashboard_seasons_get GET /v1/dashboard/seasons Get Seasonal Broadcast Distributions
DashboardApi v1_dashboard_stats_get GET /v1/dashboard/stats Get Platform Stats
DashboardApi v1_dashboard_users_get GET /v1/dashboard/users Get Users Directory (Admin Only)
EpisodesApi v1_anime_slug_episodes_get GET /v1/anime/{slug}/episodes List Episodes by Anime Slug
EpisodesApi v1_episodes_id_stream_get GET /v1/episodes/{id}/stream Get Episode Stream Sources
SampleApi v1_protected_sample_get GET /v1/protected/sample Protected Sample Endpoint
SystemApi health_get GET /health Health Check
UploadApi v1_upload_hls_post POST /v1/upload/hls Upload HLS Package to Cloudflare R2
UploadApi v1_upload_image_post POST /v1/upload/image Upload Image to Cloudflare R2
UserApi v1_user_history_delete DELETE /v1/user/history Clear All History
UserApi v1_user_history_get GET /v1/user/history Get Watch History
UserApi v1_user_history_id_delete DELETE /v1/user/history/{id} Delete History Item
UserApi v1_user_history_post POST /v1/user/history Record Playback Progress
UserApi v1_user_profile_get GET /v1/user/profile Get User Profile
UserApi v1_user_settings_get GET /v1/user/settings Get User Settings
UserApi v1_user_settings_patch PATCH /v1/user/settings Update User Settings
UserApi v1_user_watchlist_anime_id_delete DELETE /v1/user/watchlist/{animeId} Remove from Watchlist
UserApi v1_user_watchlist_anime_id_patch PATCH /v1/user/watchlist/{animeId} Update Watchlist Entry
UserApi v1_user_watchlist_get GET /v1/user/watchlist Get User Watchlist
UserApi v1_user_watchlist_post POST /v1/user/watchlist Add to Watchlist

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

Bearer

  • Type: Bearer authentication (JWT / API-Key)

Author

dev@gox.my.id

About

Official python SDK for ShionStream API

Resources

Readme
Apache-2.0 license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages