WeverseClient¶

class Weverse.WeverseClient(**kwargs)¶

Abstract & Parent Client for connecting to Weverse and creating the internal cache.

Do not create an object directly from this class. Instead, create a Weverse.WeverseClientSync or Weverse.WeverseClientAsync object since those are concrete.

Parameters

verbose (bool) – Whether to print out verbose messages.
web_session – An aiohttp or requests client session.
authorization (str) – The account token to connect to the Weverse API. In order to find your token, please refer to Get Account Token
username (str) – The email or username associated with the account.
password (str) – The password associated with the account.
hook – A passed in method that will be called every time there is a new notification. This method must take in a list of models.Notification objects.

verbose¶

Whether to print out verbose messages.

Type: bool

web_session¶: An aiohttp or requests client session.

user_notifications¶

Most recent notifications of the account connected.

Type: list

cache_loaded¶

Whether the Internal Weverse Cache is fully loaded. This will change for a split moment when grabbing a new post.

Type: bool

user_endpoint¶

User info endpoint.

Type: str

all_posts¶

All posts in cache where the Post ID is the key and the value is the Post Object

Type: dict(Post)

all_artists¶

All artists in cache where the Artist ID is the key and the value is the Artist Object

Type: dict(Artist)

all_comments¶

All comments in cache where the Comment ID is the key and the value is the Comment Object

Type: dict(Comment)

all_notifications¶

All notifications in cache where the Notification ID is the key and the value is the Notification Object

Type: dict(Notification)

all_photos¶

All photos in cache where the Photo ID is the key and the value is the Photo Object

Type: dict(Photo)

all_communities¶

All communities in cache where the Community ID is the key and the value is the Community Object

Type: dict(Community)

all_media¶

All media in cache where the Media ID is the key and the value is the Media Object

Type: dict(Media)

all_tabs¶

All tabs in cache where the Tab ID is the key and the value is the Tab Object

Type: dict(Tab)

all_videos¶

All videos in cache where the Video URL is the key and the value is the Video Object

Type: dict(Video)

all_announcements¶

All announcements/notices in cache where the Announcement ID is the key and the value is the Announcement Object

Type: dict(Announcement)

check_status(status, url) → bool¶

Confirm the status of a URL

Parameters

status – Status code of url connection
url – Link that we connected to.

Returns

True if the connection was a success.

Raises

Invalid Token if there was an invalid token.

static determine_notification_type(notification: Union[Notification, str]) → str¶

Determine the post type based on the notification body or the Notification object itself.

Since notifications do not differentiate between Posts and Comments, this is for that purpose.

Parameters: notification – The message body of the notification or the notification itself.
Returns: A string with either “comment”, “media”, “post”, or “announcement”.

get_announcement_by_id(announcement_id) → Optional[Announcement]¶

Get Announcement by the ID

Parameters: announcement_id – Media ID
Returns: Optional[Announcement]

get_artist_by_id(artist_id) → Optional[Artist]¶

Get artist by their ID.

Parameters: artist_id – The artist’s ID
Returns: Optional[Artist]

get_comment_by_id(comment_id) → Optional[Comment]¶: Get a comment by the ID :param comment_id: Comment ID :returns: Optional[Comment]

get_community_by_id(community_id) → Optional[Community]¶

Get a community by the ID.

Parameters: community_id – Community ID
Returns: Optional[Community]

get_media_by_id(media_id) → Optional[Media]¶

Get Media by the ID

Parameters: media_id – Media ID
Returns: Optional[Media]

get_new_notifications() → List[Notification]¶

Will get the new notifications from the last notification check.

Should only be used after check_new_user_notifications OR update_cache_from_notification.

Returns: List[Notification]

get_notification_by_id(notification_id) → Optional[Notification]¶

Get a notification by the ID

Parameters: notification_id – Notification ID
Returns: Optional[Notification]

get_photo_by_id(photo_id) → Optional[Photo]¶

Get a photo by the ID

Parameters: photo_id – Photo ID
Returns: Optional[Photo]

get_post_by_id(post_id) → Optional[Post]¶

Get a post by the ID

Parameters: post_id – Post ID
Returns: Optional[Post]

get_tab_by_id(tab_id) → Optional[Tab]¶

Get tab by their ID.

Parameters: tab_id – The tab ID
Returns: Optional[Tab]

get_video_by_url(video_url) → Optional[Video]¶

Get a video by the direct URL.

Parameters: video_url – URL of the video
Returns: Optional[Video]

static process_community_artists_and_tabs(community, response_text_as_dict)¶

Process the community artists and tabs and add them to their respective communities.

Parameters

community – Community object
response_text_as_dict – Response text of connection to endpoint but as a dict.

property public_weverse_key: str¶: Hard-coded weverse key

stop()¶: Stop the hook loop.

Clients¶

WeverseClientSync¶

class Weverse.WeverseClientSync(**kwargs)¶

Synchronous Weverse Client that Inherits from WeverseClient.

Parameters: kwargs – Same as WeverseClient.

Attributes are the same as WeverseClient.

check_new_user_notifications()¶

Checks if there is a new user notification, updates the cache, and returns if there was.

Returns: (bool) Whether there is a new notification.

This endpoint has been acting a bit off and not producing accurate results. It would be recommended to instantly get new notifications with update_cache_from_notification instead.

check_token_works()¶

Check if a token is invalid.

Returns: (bool) True if the token works.

create_communities()¶: Get and Create the communities the logged in user has access to.

create_community_artists_and_tabs()¶: Create the community artists and tabs and add them to their respective communities.

create_media(community: Community)¶

Paginate through a community’s media and add it to object cache.

Parameters: community – Community the posts exist under.

create_post(community: Community, post_id) → Post¶

Create a post and update the cache with it. This is meant for an individual post.

Parameters

community – Community the post was created under.
post_id – The id of the post we are needing to fetch.

create_posts(community: Community, next_page_id: int = None)¶

Paginate through a community’s posts and add it to object cache.

Parameters

community – Community the posts exist under.
next_page_id ([OPTIONAL]) – Next Page ID (Weverse paginates posts).

fetch_announcement(community_id: int, announcement_id: int) → Optional[Announcement]¶

Receive announcement object based on announcement id.

Parameters

community_id – The ID of the community the media belongs to.
announcement_id – The ID of the announcement to fetch.

Returns

Announcement or NoneType

fetch_artist_comments(community_id, post_id)¶

Fetches the artist comments on a post.

Parameters

community_id – Community ID the post is on.
post_id – Post ID to fetch the artist comments of.

Returns

List[Comment]

fetch_comment_body(community_id, comment_id)¶

Fetches a comment from its ID.

Parameters

community_id – The ID of the community the comment belongs to.
comment_id – The ID of the comment to fetch.

Returns

(str) Body of the comment.

fetch_media(community_id, media_id)¶

Receive media object based on media id.

Parameters

community_id – The ID of the community the media belongs to.
media_id – The ID of the media to fetch.

Returns

Media or NoneType

get_user_notifications()¶

Get a list of updated user notification objects.

Returns: List[Notification]

start(create_old_posts=False, create_notifications=True, create_media=False)¶

Creates internal cache.

This is the main process that should be run.

Parameters

create_old_posts – (bool) Whether to create cache for old posts.
create_notifications – (bool) Whether to create/update cache for old notifications.
create_media – (bool) Whether to create/update cache for old media.

Raises

Weverse.error.InvalidToken If the token was invalid.

Raises

Weverse.error.BeingRateLimited If the client is being rate-limited.

Raises

Weverse.error.LoginFailed Login process had failed.

Raises

Weverse.error.InvalidCredentials If the user credentials were invalid or not provided.

translate(post_or_comment_id, is_post=False, is_comment=False, p_obj=None, community_id=None)¶

Translates a post or comment, must set post or comment to True.

Parameters

post_or_comment_id – A post or comment ID.
is_post ([OPTIONAL]) – If we passed in a post.
is_comment ([OPTIONAL]) – If we passed in a comment
p_obj ([OPTIONAL]) – The object we are looking to translate
community_id ([OPTIONAL]) – The community id the post/comment was made under.

Returns

(str) Translated message or NoneType

update_cache_from_notification() → List[Notification]¶

Grab a new post based from new notifications and add it to cache.

Will also return the new notifications found.

Returns: List[models.Notification]

WeverseClientAsync¶

class Weverse.WeverseClientAsync(loop=<_UnixSelectorEventLoop running=False closed=False debug=False>, **kwargs)¶

Asynchronous Weverse Client that Inherits from WeverseClient.

Parameters

loop – Asyncio Event Loop
kwargs – Same as WeverseClient.

loop¶: Asyncio Event Loop

Attributes are the same as :ref:`WeverseClient`.

async check_new_user_notifications() → bool¶

Checks if there is a new user notification, updates the cache, and returns if there was.

This is a coroutine and must be awaited.

Returns: (bool) Whether there is a new notification.

This endpoint has been acting a bit off and not producing accurate results. It would be recommended to instantly get new notifications with update_cache_from_notification instead.

async check_token_works() → bool¶

Check if a token is invalid.

This is a coroutine and must be awaited.

Returns: (bool) True if the token works.

property cookies: Optional[dict]¶: Get the user’s cookies in order to access media.

async create_communities()¶

Get and Create the communities the logged in user has access to.

This is a coroutine and must be awaited.

async create_community_artists_and_tabs(specific_community_ids: List[int] = None)¶

Create the community artists and tabs and add them to their respective communities.

Parameters: specific_community_ids – List[int] Will only do this list of community ids from the already existing communities.

This is a coroutine and must be awaited.

async create_media(community: Community)¶

Paginate through a community’s media and add it to object cache.

Parameters: community – Community the posts exist under.

async create_post(community: Community, post_id) → Post¶

Create a post and update the cache with it. This is meant for an individual post.

This is a coroutine and must be awaited.

Parameters

community – Community the post was created under.
post_id – The id of the post we are needing to fetch.

async create_posts(community: Community, next_page_id: int = None)¶

Paginate through a community’s posts and add it to object cache.

This is a coroutine and must be awaited.

Parameters

community – Community the posts exist under.
next_page_id ([OPTIONAL]) – Next Page ID (Weverse paginates posts).

async download_video_stream(video_stream_obj: VideoStream, output_file_path)¶

Download a video stream to a local folder.

Parameters

video_stream_obj (VideoStream) –
output_file_path (str) – Full file path with file extension.

Return type

Returns False if no community id is found with the VideoStream object.

async fetch_announcement(community_id: int, announcement_id: int) → Optional[Announcement]¶

Receive announcement object based on announcement id.

This is a coroutine and must be awaited.

Parameters

community_id – The ID of the community the media belongs to.
announcement_id – The ID of the announcement to fetch.

Returns

Announcement or NoneType

async fetch_artist_comments(community_id, post_id)¶

Fetches the artist comments on a post.

This is a coroutine and must be awaited.

Parameters

community_id – Community ID the post is on.
post_id – Post ID to fetch the artist comments of.

Returns

List[Comment]

async fetch_comment_body(community_id, comment_id) → str¶

Fetches a comment from its ID.

This is a coroutine and must be awaited.

Parameters

community_id – The ID of the community the comment belongs to.
comment_id – The ID of the comment to fetch.

Returns

(str) Body of the comment.

async fetch_media(community_id, media_id) → Optional[Media]¶

Receive media object based on media id.

This is a coroutine and must be awaited.

Parameters

community_id – The ID of the community the media belongs to.
media_id – The ID of the media to fetch.

Returns

Media or NoneType

async follow_all_communities()¶: Follow all communities on Weverse

async follow_community(community_id: Union[int, str], attempts: int = 0)¶

Follow a community

Parameters

community_id – Union[int, str] The community ID to follow.
attempts – int The number of attempts for choosing a nickname after error.

async get_all_community_ids() → List[int]¶

Get all the communities on Weverse.

Returns: List[int] A list of community ids

async get_cookies(video_url_without_drm_type) → Optional[dict]¶

Get the user’s cookies in order to access media.

Parameters: video_url_without_drm_type – EX: https://weversewebapi.weverse.io/wapi/v1/communities/2/videos/4093
Returns: Optional[dict] A dictionary containing a signed cookie.

async get_user_notifications()¶

Get a list of updated user notification objects.

This is a coroutine and must be awaited.

Returns: List[Notification]

async run_blocking_code(funcs, *args, **kwargs) → list¶

Run blocking code safely in a new thread. DO NOT pass in an asynchronous function. If an asynchronous function has blocking code, the event loop will also block. There were several attempts made to make it compatible with asynchronous functions, but it was a headache to work with.

Parameters

funcs – The blocking function that needs to be called. May also pass in a list of functions with the 0th index as the callable function, the 1st index as the args for that function, and the 2nd index as the kwargs for that function.
args – The args to pass into the blocking function.
kwargs – The keyword args to pass into the blocking function.

Returns

List of results in no particular order. Make sure the output can be managed with no specific order.

async start(create_old_posts=False, create_notifications=True, create_media=False, follow_new_communities=True)¶

Creates internal cache.

This is the main process that should be run.

This is a coroutine and must be awaited.

Parameters

create_old_posts – (bool) Whether to create cache for old posts.
create_notifications – (bool) Whether to create/update cache for old notifications.
create_media – (bool) Whether to create/update cache for old media.
follow_new_communities – bool Check for new communities and automatically follow them.

Raises

Weverse.error.InvalidToken If the token was invalid.

Raises

Weverse.error.BeingRateLimited If the client is being rate-limited.

Raises

Weverse.error.LoginFailed Login process had failed.

Raises

asyncio.exceptions.TimeoutError Waited too long for a login.

Raises

Weverse.error.InvalidCredentials If the user credentials were invalid or not provided.

async translate(post_or_comment_id, is_post=False, is_comment=False, p_obj=None, community_id=None)¶

Translates a post or comment, must set post or comment to True.

This is a coroutine and must be awaited.

Parameters

post_or_comment_id – A post or comment ID.
is_post ([OPTIONAL]) – If we passed in a post.
is_comment ([OPTIONAL]) – If we passed in a comment
p_obj ([OPTIONAL]) – The object we are looking to translate
community_id ([OPTIONAL]) – The community id the post/comment was made under.

Returns

(str) Translated message or NoneType

async update_cache_from_notification() → List[Notification]¶

Grab a new post based from new notifications and add it to cache.

Will also return the new notifications found.

This is a coroutine and must be awaited.

Returns: List[models.Notification]

Models¶

Community¶

class Weverse.models.Community(**kwargs)¶

A Community object that represents a Weverse Community.

It is not suggested to create a Community manually, but rather through the following method: Weverse.objects.create_community_objects

The information retrieved on a Community is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Communities have the same ID.

x != y: Checks if two Communities do not have the same ID.

str(x): Returns the Community’s name.

Parameters

id (int) – The Community ID.
name (str) – The Community Name.
description (str) – Description of the Community.
member_count (int) – Amount of members in the community.
home_banner (str) – Direct Image URL to the home banner.
icon (str) – Direct Image URL to the Icon.
Banner (str) – Direct Image URL to the Banner.
full_name (str) – Full Name of the Community.
fc_member (bool) – If a special membership is required to join.
show_member_count (bool) – If the member count is visible.

id¶

The Community ID.

Type: int

name¶

The Community Name.

Type: str

description¶

Description of the Community.

Type: str

member_count¶

Amount of members in the community.

Type: int

home_banner¶

Direct Image URL to the home banner.

Type: str

icon¶

Direct Image URL to the Icon.

Type: str

Banner¶

Direct Image URL to the Banner.

Type: str

full_name¶

Full Name of the Community.

Type: str

fc_member¶

If a special membership is required to join.

Type: bool

show_member_count¶

If the member count is visible.

Type: bool

artists¶

List of artists the community has.

Type: List[Artist]

tabs¶

The Tabs the community has.

Type: List[Tab]

Notification¶

class Weverse.models.Notification(**kwargs)¶

A Media object that represents a Weverse Media Post.

It is not suggested to create a Notification object manually, but rather through the following method: Weverse.objects.create_notification_objects

The information retrieved on a Notification is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Notifications have the same ID.

x != y: Checks if two Notifications do not have the same ID.

Parameters

id (int) – The id of the notification.
message (str) – The message of the notification.
bold_element (str) – The bolded element in the notification.
community_id (int) – The community id associated with the notification.
community_name (str) – The community name associated with the notification.
contents_type (str) – The type of post it is.
contents_id (int) – The id of the content post.
notified_at – The time the notification was triggered.
icon_image_url (str) – Icon image url of the notification.
thumbnail_image_url (str) – Thumbnail url of the notification.
artist_id (int) – The ID of the Artist that released the content.
is_membership_content (bool) – If the content is exclusive to members.
is_web_only (bool) – Whether the notification is only available directly on the website.
platform (str) – The platform of the notification.

id¶

The id of the notification.

Type: int

message¶

The message of the notification.

Type: str

bold_element¶

The bolded element in the notification.

Type: str

community_id¶

The community id associated with the notification.

Type: int

community_name¶

The community name associated with the notification.

Type: str

contents_type¶

The type of post it is.

Type: str

contents_id¶

The id of the content post.

Type: int

notified_at¶: The time the notification was triggered.

icon_image_url¶

Icon image url of the notification.

Type: str

thumbnail_image_url¶

Thumbnail url of the notification.

Type: str

artist_id¶

The ID of the Artist that released the content.

Type: int

is_membership_content¶

If the content is exclusive to members.

Type: bool

is_web_only¶

Whether the notification is only available directly on the website.

Type: bool

platform¶

The platform of the notification.

Type: str

Photo¶

class Weverse.models.Photo(**kwargs)¶

A Photo object that represents a Weverse Photo that belongs to media or a post.

It is not suggested to create a Photo manually, but rather through the following method: Weverse.objects.create_photo_objects

The information retrieved on a Photo is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Photo objects have the same ID.

x != y: Checks if two Photo objects do not have the same ID.

str(x): Returns the file name.

Parameters

id (int) – The ID of the photo.
content_index (int) – Index the photo is in from a bundle of photos.
thumbnail_img_url (str) – The thumbnail image link.
thumbnail_img_width (str) – The original image width.
thumbnail_img_height (str) – The thumbnail image height.
original_img_url (str) – The original image link.
original_img_width (str) – The original image width.
original_img_height (str) – The original image height.
file_name (str) – File name of the photo.

id¶

The ID of the photo.

Type: int

media_id¶

The media ID of the photo (if there is one).

Type: Optional[int]

content_index¶

Index the photo is in from a bundle of photos.

Type: int

thumbnail_img_url¶

The thumbnail image link.

Type: str

thumbnail_img_width¶

The original image width.

Type: str

thumbnail_img_height¶

The thumbnail image height.

Type: str

original_img_url¶

The original image link.

Type: str

original_img_width¶

The original image width.

Type: str

original_img_height¶

The original image height.

Type: str

file_name¶

File name of the photo.

Type: str

post¶

The Post Object the photo belongs to.

Type: Post

Video¶

class Weverse.models.Video(**kwargs)¶

A Video object that represents a Weverse Video that belongs to media or a post.

It is not suggested to create a Video manually, but rather through the following method: Weverse.objects.create_video_objects

The information retrieved on a Video is directly from the Weverse API and altered to fit this class.

Videos do not have unique IDs.

x == y: Check if the Video URL and Post are the same.

x != y: Check if the Video objects are not equal.

str(x): Returns the Video URL.

len(x): Returns the length of the video in seconds.

Parameters

video_url (int) – Direct URL to the video.
thumbnail_url (str) – URL of the thumbnail.
thumbnail_width (int) – Width of the thumbnail
thumbnail_height (int) – Height of the thumbnail.
length (int) – Duration of the video in seconds.

video_url¶

Direct URL to the video.

Type: int

thumbnail_url¶

URL of the thumbnail.

Type: str

thumbnail_width¶

Width of the thumbnail

Type: int

thumbnail_height¶

Height of the thumbnail.

Type: int

playtime¶

Duration of the video in seconds.

Type: int

post¶

The Post Object the video belongs to.

Type: Optional[Post]

VideoStream¶

class Weverse.models.VideoStream(**kwargs)¶

A video stream that inherits from Video

hls_path¶

Link to the .m3u8 file.

Type: str

dash_path¶

Link to the .mpd file.

Type: str

content_index¶

Index of the videos.

Type: int

video_id¶

Unique Video ID

Type: int

encoding_status¶

Encoding Status of the Video Stream.

Type: str

type¶

The type of video it is.

Type: str

video_width¶

The width of the video

Type: int

video_height¶

The height of the video

Type: int

is_vertical¶

If the video is vertical.

Type: bool

caption_s3_paths¶

A list of caption paths.

Type: List[str]

level¶

The users that are able to view the video.

Type: str

base_url¶

The base url of the video to access files.

Type: str

m3u8_urls¶

Several urls for the resolution m3u8 files.

Type: str

Artist¶

class Weverse.models.Artist(**kwargs)¶

An Artist object that represents a Weverse Artist that belongs in a community.

It is not suggested to create an Artist manually, but rather through the following method: Weverse.objects.create_artist_objects

The information retrieved on an Artist is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Artists have the same ID.

x != y: Checks if two Artists do not have the same ID.

str(x): Returns the Artist’s primary name.

Parameters

id (int) – The Artist ID.
community_user_id (int) – Artist’s ID in the community.
name (str) – The Primary Artist Name.
list_name (list) – A list of names for the Artist.
is_online (bool) – Whether the Artist is currently online
profile_nick_name (str) – Artist nickname.
profile_img_path (str) – Image URL for the Artist’s profile.
is_birthday (bool) – Whether it is the Artist’s birthday.
group_name (str) – The group name the Artist is associated with.
max_comment_count (int) – The maximum amount of comments this Artist can post.
community_id (int) – The ID of the community this Artist object was selected from.
is_enabled (bool) – If the Artist account is enabled.
has_new_to_fans (bool) – If the Artist has a new post for fans.
has_new_private_to_fans (bool) – If the Artist has a new private post for fans.
to_fan_last_id (int) – The latest tofan post ID.
to_fan_last_created_at – When the artist’s last tofan post was created.
to_fan_last_expire_in – When the artist’s last tofan post expires.
birthday_img_url (str) – A direct image url to the artist’s birthday image.
community (Community) – The community the Artist is in.
posts (list) – A list of posts the Artist has.

id¶

The Artist ID.

Type: int

community_user_id¶

Artist’s ID in the community.

Type: int

name¶

The Primary Artist Name.

Type: str

list_name¶

A list of names for the Artist.

Type: list

is_online¶

Whether the Artist is currently online

Type: bool

profile_nick_name¶

Artist nickname.

Type: str

profile_img_path¶

Image URL for the Artist’s profile.

Type: str

is_birthday¶

Whether it is the Artist’s birthday.

Type: bool

group_name¶

The group name the Artist is associated with.

Type: str

max_comment_count¶

The maximum amount of comments this Artist can post.

Type: int

community_id¶

The ID of the community this Artist object was selected from.

Type: int

is_enabled¶

If the Artist account is enabled.

Type: bool

has_new_to_fans¶

If the Artist has a new post for fans.

Type: bool

has_new_private_to_fans¶

If the Artist has a new private post for fans.

Type: bool

to_fan_last_id¶

The latest tofan post ID.

Type: int

to_fan_last_created_at¶: When the artist’s last tofan post was created.

to_fan_last_expire_in¶: When the artist’s last tofan post expires.

birthday_img_url¶

A direct image url to the artist’s birthday image.

Type: str

community¶

The community the Artist is in.

Type: Community

posts¶

A list of posts the Artist has.

Type: list

Comment¶

class Weverse.models.Comment(**kwargs)¶

A Comment object that represents a Weverse Comment that belongs to an Artist.

It is not suggested to create a Comment manually, but rather through the following method: Weverse.objects.create_comment_objects

The information retrieved on a Comment is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Comments have the same ID.

x != y: Checks if two Comments do not have the same ID.

str(x): Returns the comment’s body.

Parameters

id (int) – The ID of the comment.
body (str) – The comment content AKA the body of the message.
comment_count (int) – Amount of comments inside of this comment (replies).
like_count (int) – Amount of likes on the comment.
has_my_like (bool) – Whether the client has liked the comment.
is_blind (bool) – NOT SURE WHAT THIS IS
post_id (int) – The Post ID that the comment was created under.
created_at – The time the comment was created.
updated_at – The time the comment was updated.

id¶

The ID of the comment.

Type: int

body¶

The comment content AKA the body of the message.

Type: str

comment_count¶

Amount of comments inside of this comment (replies).

Type: int

like_count¶

Amount of likes on the comment.

Type: int

has_my_like¶

Whether the client has liked the comment.

Type: bool

is_blind¶

NOT SURE WHAT THIS IS

Type: bool

post_id¶

The Post ID that the comment was created under.

Type: int

created_at¶: The time the comment was created.

updated_at¶: The time the comment was updated.

post¶

The Post Object the comment belongs to.

Type: Post

Post¶

class Weverse.models.Post(**kwargs)¶

A Post object that represents a Weverse Post.

It is not suggested to create a Post manually, but rather through the following method: Weverse.objects.create_post_objects

The information retrieved on a Post is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Post objects have the same ID.

x != y: Checks if two Post objects do not have the same ID.

str(x): Returns the Post body message.

len(x): Returns the amount of images (not videos) available.

Parameters

id (int) – The ID of the post.
community_tab_id (int) – The tab the post is under.
type (str) – The type of Post.
body (str) – Body Message on the Post.
comment_count (int) – Current amount of comments on the Post
like_count (int) – Current amount of likes on the Post
max_comment_count (int) – Maximum amount of comments that can be on the Post
has_my_like (bool) – If the client user has the post liked.
has_my_bookmark (bool) – If the client user has the post bookmarked.
created_at – When the post was created
updated_at – When the post was last modified.
is_locked (bool) – Whether the post is locked.
is_blind (bool) – Whether the post is visible?? Unknown
is_active (bool) – Whether the post is active.
is_private (bool) – Whether the post is private.
photos (List[Photo]) – A list of photos under the post.
videos (List[Video]) – A list of videos under the post.
is_hot_trending_post (bool) – If the post is trending.
is_limit_comment (bool) – If the comments are limited.
artist_comments (List[Comment]) – The Artist comments under the post.
community_artist_id (int) – The Community Artist ID that made the post.
artist_id (int) – The ID of the Artist that made the post.

id¶

The ID of the post.

Type: int

community_tab_id¶

The tab the post is under.

Type: int

type¶

The type of Post.

Type: str

body¶

Body Message on the Post.

Type: str

comment_count¶

Current amount of comments on the Post

Type: int

like_count¶

Current amount of likes on the Post

Type: int

max_comment_count¶

Maximum amount of comments that can be on the Post

Type: int

has_my_like¶

If the client user has the post liked.

Type: bool

has_my_bookmark¶

If the client user has the post bookmarked.

Type: bool

created_at¶: When the post was created

updated_at¶: When the post was last modified.

is_locked¶

Whether the post is locked.

Type: bool

is_blind¶

Whether the post is visible?? Unknown

Type: bool

is_active¶

Whether the post is active.

Type: bool

is_private¶

Whether the post is private.

Type: bool

photos¶

A list of photos under the post.

Type: List[Photo]

videos¶

A list of videos under the post.

Type: List[Video]

is_hot_trending_post¶

If the post is trending.

Type: bool

is_limit_comment¶

If the comments are limited.

Type: bool

artist_comments¶

The Artist comments under the post.

Type: List[Comment]

community_artist_id¶

The Community Artist ID that made the post.

Type: int

artist_id¶

The ID of the Artist that made the post.

Type: int

artist¶

The Artist Object the post belongs to.

Type: Artist

Tab¶

class Weverse.models.Tab(tab_id=None, name=None)¶

A Post object that represents a Weverse Post.

It is not suggested to create a Post manually, but rather through the following method: Weverse.objects.create_post_objects

The information retrieved on a Post is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Tab objects have the same ID.

x != y: Check if the IDs of the Tab objects are not equal.

str(x): Returns the Tab name.

Parameters

tab_id ([Optional] int) – The ID of the Tab.
name ([Optional] str) – The Tab name.

id¶

The ID of the Tab.

Type: int

name¶

The Tab name.

Type: str

Media¶

class Weverse.models.Media(**kwargs)¶

A Media object that represents a Weverse Media Post.

It is not suggested to create a Media object manually, but rather through the following method: Weverse.objects.create_media_object

The information retrieved on Media is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Media objects have the same ID.

x != y: Checks if two Media objects do not have the same ID.

Parameters

id (int) – ID of the Media post.
community_id (int) – ID of the Community the media post was made in.
body (str) – The media content AKA the body of the message.
type (str) – The type of media post it is.
thumbnail_path (str) – The (url??) of the thumbnail.
title (str) – The title of the media post.
level – The level of access the media post is categorized under.
video_link (str) – The video link supplied under the media post.
youtube_id (str) – The youtube video ID.

id¶

ID of the Media post.

Type: int

community_id¶

ID of the Community the media post was made in.

Type: int

body¶

The media content AKA the body of the message.

Type: str

type¶

The type of media post it is.

Type: str

thumbnail_path¶

The (url??) of the thumbnail.

Type: str

title¶

The title of the media post.

Type: str

level¶: The level of access the media post is categorized under.

video_link¶

The video link supplied under the media post.

Type: str

youtube_id¶

The youtube video ID.

Type: str

photos¶

A list of photos under the media post.

Type: List[Photo]

videos¶

A list of videos under the media post.

Type: List[Video]

Announcement¶

class Weverse.models.Announcement(**kwargs)¶

An Announcement object that represents a Weverse Notice for a Community.

It is not suggested to create an Announcement manually, but rather through the following method: Weverse.objects.create_announcement_objects

The information retrieved on a Post is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Announcement objects have the same ID.

x != y: Checks if two Announcement objects do not have the same ID.

str(x): Returns the Announcement content.

Parameters

id (int) – The ID of the post.
communityId (int) – The Community ID.
title (str) – The title of the announcement notice.
content (str) – The HTML body of the page notice.
createdAt (str) – Timestamp with the date of when the announcement was created.
exposedAt (str) – Timestamp with the date of when the announcement was released.
categoryId (int) – Category that the announcement belongs to (used for paginating or quick endpoint access)
fcOnly (bool) – If only premium members have access to the announcement.

id¶

The ID of the post.

Type: int

community_id¶

The Community ID.

Type: int

title¶

The title of the announcement notice.

Type: str

html_content¶

The HTML body of the page notice.

Type: str

created_at¶

Timestamp with the date of when the announcement was created.

Type: str

exposed_at¶

Timestamp with the date of when the announcement was released.

Type: str

category_id¶

Category that the announcement belongs to (used for paginating or quick endpoint access)

Type: int

fc_only¶

If only premium members have access to the announcement.

Type: bool

image_url¶

An image url if one is present.

Type: Optional[str]

content¶

Body Content without the HTML tags.

Type: str

Model Creation¶

Weverse.objects.create_announcement_object(announcement_info: dict) → Announcement¶

Creates and returns an announcement object

Parameters: announcement_info – Announcement information from endpoint.
Returns: Announcement

Weverse.objects.create_artist_objects(current_artists: list) → list¶

Creates artist objects based on a list of information sent in and returns the objects.

Parameters: current_artists – Artist information received from endpoint.
Returns: List[Artist]

Weverse.objects.create_comment_objects(current_comments: list) → list¶

Creates & Returns comment objects based on a list of comments

Parameters: current_comments – comment information from endpoint.
Returns: List[Comment]

Weverse.objects.create_community_objects(current_communities: list, already_existing: Optional[Dict[int, Community]] = None) → dict¶

Creates community objects based on a list of information sent in and returns the objects.

Parameters

current_communities – A list of communities from the endpoint being followed. Community information received from endpoint.
already_existing – List[Community] Already existing Communities that should not be replaced.

Returns

dict{community id: Community}

Weverse.objects.create_media_object(media_info: dict, ignore_photos=False, ignore_videos=False) → Media¶

Creates and returns a media object

Parameters

media_info – media information from endpoint.
ignore_photos – Whether to ignore the photos that belong in the media object. (Other methods can create it themselves.)
ignore_videos – Whether to ignore the videos that belong in the media object. (Other methods can create it themselves.)

Returns

Media

Weverse.objects.create_notification_objects(current_notifications: list) → list¶

Creates notification objects based on a list of information sent in and returns the objects.

Parameters: current_notifications – Notification information received from endpoint.
Returns: List[Notification]

Weverse.objects.create_photo_objects(current_photos: list) → list¶

Creates & Returns photo objects based on a list of photos

Parameters: current_photos – photo information from endpoint.
Returns: List[Photo]

Weverse.objects.create_post_objects(current_posts: list, community: Community, new=False) → list¶

Creates post objects based on a list of posts sent in and the community and returns the objects.

Parameters

current_posts – Post information received from endpoint.
community – Community that the post belongs in.
new – bool Whether or not the post is new.

Returns

List[Post]

Weverse.objects.create_tab_objects(current_tabs: list) → list¶

Creates tab objects based on a list of information sent in and returns the objects.

Parameters: current_tabs – Tab information received from endpoint.
Returns: List[Tab]

Weverse.objects.create_video_objects(current_videos: list, community_id=None) → list¶

Creates & Returns video objects based on a list of videos.

Parameters

current_videos – Video information from api endpoint.
community_id – Community ID

Returns

List[Video]

Weverse.objects.iterate_community_media_categories(all_media_categories: dict) → [List[Weverse.models.media.Media], List[dict]]¶

Iterates through community media categories, creates Media posts and returns a list of them.

Parameters: all_media_categories – A dict containing media posts that are filtered by category.
Returns: [List[Media], List[dict]] A list of Video Media objects and a list of dicts containing photo media objects to later make own calls on to retrieve photos.

Exceptions¶

Invalid Token¶

exception Weverse.InvalidToken¶: An Exception Raised When an Invalid Token was Supplied.

Page Not Found¶

exception Weverse.PageNotFound(url)¶

An Exception Raised When a link was not found.

Parameters: url (str) – The link that was not found.

Being Rate Limited¶

exception Weverse.BeingRateLimited¶: An Exception Raised When Weverse Is Being Rate-Limited.

Get Account Token¶

Your account token is needed (Will need to be updated about every 6 months iirc).

Note that it is now possible to log-in with a username and password to prevent manual updates.

In order to get your account token, go to https://www.weverse.io/ and Inspect Element (F12).

Then go to the Network tab and filter by XHR.

Then refresh your page (F5) and look for info or me under XHR.

Under Headers, scroll to the bottom and view the request headers.

You want to copy everything past authorization: Bearer.

For example, you may see (This is just an example):

authorization: Bearer ABCDEFGHIJKLMNOPQRSTUVWXYZ

Then ABCDEFGHIJKLMNOPQRSTUVWXYZ would be your auth token for Weverse.

It is suggested to have the auth token as an environment variable.

IMPORTANT NOTE: Not all korean key-phrases may be logged. Scroll to the bottom of the Weverse page when you are logged in and click “English” to set the account language to English.

Asynchronous Usage¶

# Asynchronous
import asyncio
import aiohttp
from Weverse.error import InvalidToken
from Weverse.weverseasync import WeverseClientAsync

# THERE IS A MORE DETAILED EXAMPLE IN THE EXAMPLES FOLDER
# https://github.com/MujyKun/Weverse/blob/main/examples/asynchronous.py

token = "fake_token"  # REQUIRED
# THE EXAMPLE IN THE EXAMPLES FOLDER WILL SHOW YOU HOW TO LOGIN WITH A USERNAME AND PASSWORD AND SET UP HOOKS.

# It is advised to pass in your own web session as it is not closed in Weverse
web_session = aiohttp.ClientSession()  # A session is created by default
weverse_client = WeverseClientAsync(authorization=token, verbose=True, loop=asyncio.get_event_loop(),
                                    web_session=web_session)
try:
    # creates all the cache that is specified. If the create parameters are set to True, they will take a very long time.
    await weverse_client.start(create_old_posts=True, create_media=True)
except InvalidToken:
    print("Invalid Token")

Synchronous Usage¶

# Synchronous
import requests
from Weverse.weversesync import WeverseClientSync
from Weverse.error import InvalidToken

# THERE IS A MORE DETAILED EXAMPLE IN THE EXAMPLES FOLDER
# https://github.com/MujyKun/Weverse/blob/main/examples/synchronous.py

token = "fake_token"  # REQUIRED
# THE EXAMPLE IN THE EXAMPLES FOLDER WILL SHOW YOU HOW TO LOGIN WITH A USERNAME AND PASSWORD AND SET UP HOOKS.

# It is advised to pass in your own web session as it is not closed in Weverse
web_session = requests.Session()  # A session is created by default
weverse_client = WeverseClientSync(authorization=token, verbose=True)
try:
    # creates all the cache that is specified. If the create parameters are set to True, they will take a very long time.
    weverse_client.start(create_old_posts=True, create_media=True)
except InvalidToken:
    print("Invalid Token")