Reference
cocorum
An unofficial Python wrapper for the Rumble.com APIs
A Python wrapper for the Rumble Live Stream API v1.0 (beta), with some quality of life additions, such as: - Automatic refresh when past the refresh_rate delay when querying any non_static property. - All timespamps are parsed to seconds since Epoch, UTC timezone. - Chat has new_messages and new_rants properties that return only messages and rants since the last time they were read.
Modules exported by this package:
chatapi
: Provide the ChatAPI object for interacting with a livestream chat.servicephp
: Privide the ServicePHP object for interacting with the service.php API.uploadphp
: Provide the UploadPHP object for uploading videos.scraping
: Provide functions and the Scraper object for getting various data via HTML scraping.jsonhandles
: Abstract classes for handling JSON data blocks.utils
: Various utility functions for internal calculations and checks.static
: Global data that does not change across the package.
Most attributes that are not added features have the same name as the direct JSON counterparts, with the exception of adding prefixes to some things that have the same name in the JSON as Python builtin functions. For example, thing/id in JSON is thing.thing_id in this Python wrapper.
Example usage:
from cocorum import RumbleAPI
api = RumbleAPI(API_URL, refresh_rate = 10)
print(api.username)
print(api.latest_follower)
if api.latest_subscriber:
print(api.latest_subscriber, "subscribed for $" + str(api.latest_subscriber.amount_dollars))
#RumbleLivestream objects returned by RumbleAPI properties are deep: When queried, they will pull new information via their parent RumbleAPI object.
livestream = api.latest_livestream #None if there is no stream running
if livestream:
if livestream.visibility != "public":
print("Stream is not public.")
#Get messages for one minute
start_time = time.time()
while time.time() - start_time < 60 and livestream.is_live:
for message in livestream.chat.new_messages:
print(message.username, "said", message)
time.sleep(0.1)
S.D.G.
ChatMessage
Bases: JSONUserAction
A single message in a Rumble livestream chat
Source code in cocorum/__init__.py
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
|
badges
property
The user's badges
created_on
property
When the message was created, in seconds since Epoch UTC
text
property
The message text
__eq__(other)
Is this message equal to another?
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(str, ChatMessage)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/__init__.py
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
|
__str__()
Message as a string (its content)
Source code in cocorum/__init__.py
308 309 310 |
|
Follower
Bases: JSONUserAction
Rumble follower
Source code in cocorum/__init__.py
59 60 61 62 63 64 |
|
followed_on
property
When the follower followed, in seconds since Epoch UTC
LiveChat
Reference for chat of a Rumble livestream
Source code in cocorum/__init__.py
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 |
|
latest_message
property
The latest chat message
latest_rant
property
The latest chat rant
new_messages
property
Chat messages that are newer than the last time this was referenced
new_rants
property
Chat rants that are newer than the last time this was referenced
recent_messages
property
Recent chat messages
recent_rants
property
Recent chat rants
__getitem__(key)
Return a key from the stream's chat JSON
Source code in cocorum/__init__.py
390 391 392 |
|
__init__(stream)
Reference for chat of a Rumble livestream
Parameters:
Name | Type | Description | Default |
---|---|---|---|
stream
|
dict
|
The JSON block of a single Rumble livestream. |
required |
Source code in cocorum/__init__.py
378 379 380 381 382 383 384 385 386 387 388 |
|
Livestream
Rumble livestream
Source code in cocorum/__init__.py
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
|
categories
property
A list of our categories
chat
property
The livestream chat
created_on
property
When the livestream was created, in seconds since the Epock UTC
dislikes
property
Number of dislikes on the stream
is_live
property
Is the stream live?
like_ratio
property
Ratio of people who liked the stream to people who reacted total
likes
property
Number of likes on the stream
stream_id
property
The livestream ID in base 36
stream_id_b10
property
The livestream chat ID (stream ID in base 10)
stream_id_b36
property
The livestream ID in base 36
title
property
The title of the livestream
visibility
property
Is the stream public, unlisted, or private?
watching_now
property
The number of people watching now
__eq__(other)
Is this stream equal to another?
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(str, int, Livestream)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/__init__.py
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
|
__getitem__(key)
Return a key from the JSON, refreshing if necessary
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
A valid JSON key. |
required |
Source code in cocorum/__init__.py
195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
|
__init__(jsondata, api)
Rumble livestream
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON block for a single livestream. |
required |
api
|
RumbleAPI
|
The Rumble Live Stream API wrapper that spawned us. |
required |
Source code in cocorum/__init__.py
152 153 154 155 156 157 158 159 160 161 162 163 |
|
__str__()
The livestream in string form (it's ID in base 36)
Source code in cocorum/__init__.py
191 192 193 |
|
Rant
Bases: ChatMessage
A single rant in a Rumble livestream chat
Source code in cocorum/__init__.py
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 |
|
amount_cents
property
The total rant amount in cents
amount_dollars
property
The rant amount in dollars
expires_on
property
When the rant will expire, in seconds since the Epoch UTC
__eq__(other)
Is this category equal to another?
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(str, ChatMessage)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/__init__.py
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 |
|
RumbleAPI
Rumble Live Stream API wrapper
Source code in cocorum/__init__.py
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 |
|
api_type
property
Type of API URL in use, user or channel
api_url
property
writable
Our API URL
channel_id
property
The channel ID, if we are a channel
channel_name
property
The channel name, if we are a channel
data_timestamp
property
The timestamp on the last data refresh
latest_follower
property
The latest follower of this user or channel
latest_livestream
property
Return latest livestream to be created. Use this to get a single running livestream
latest_subscriber
property
The latest subscriber of this user or channel
livestreams
property
A dictionairy of our livestreams
new_followers
property
Followers that are newer than the last time this was checked (or newer than RumbleAPI object creation)
new_subscribers
property
Subscribers that are newer than the last time this was checked (or newer than RumbleAPI object creation)
num_followers
property
The number of followers of this user or channel
num_followers_total
property
The total number of followers of this account across all channels
num_subscribers
property
The number of subscribers of this user or channel
num_subscribers_total
property
The total number of subscribers of this account across all channels
recent_followers
property
A list of recent followers
recent_subscribers
property
A list of recent subscribers (shallow)
user_id
property
The user ID in base 36
user_id_b10
property
The user ID in base 10
user_id_b36
property
The user ID in base 36
username
property
The username
__getitem__(key)
Return a key from the JSON, refreshing if necessary
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
A valid JSON key. |
required |
Source code in cocorum/__init__.py
495 496 497 498 499 500 501 502 503 504 505 506 |
|
__init__(api_url, refresh_rate=static.Delays.api_refresh_default)
Rumble Live Stream API wrapper Args: api_url (str): The Rumble API URL, with the key. refresh_rate (int, float): How long to reuse queried data before refreshing. Defaults to static.Delays.api_refresh_default.
Source code in cocorum/__init__.py
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 |
|
check_refresh()
Refresh only if we are past the refresh rate
Source code in cocorum/__init__.py
508 509 510 511 |
|
refresh()
Reload data from the API
Source code in cocorum/__init__.py
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
|
StreamCategory
Bases: JSONObj
Category of a Rumble stream
Source code in cocorum/__init__.py
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
|
slug
property
Return the category's slug, AKA it's ID
title
property
Return the category's title
__eq__(other)
Is this category equal to another?
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(str, StreamCategory)
|
Other object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/__init__.py
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
|
__str__()
The category in string form
Source code in cocorum/__init__.py
146 147 148 |
|
Subscriber
Bases: JSONUserAction
Rumble subscriber
Source code in cocorum/__init__.py
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
amount_cents
property
The total subscription amount in cents
amount_dollars
property
The subscription amount in dollars
subscribed_on
property
When the subscriber subscribed, in seconds since Epoch UTC
user
property
AFAIK this is being deprecated, use username instead
__eq__(other)
Is this subscriber equal to another?
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(str, JSONUserAction, Subscriber)
|
The other object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/__init__.py
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
|
cocorum.chatapi
Internal chat API client
This part of cocorum is not part of the official Rumble Live Stream API, but may provide a more reliable method of ensuring all chat messages are received. It also can do to-chat interactions, sometimes via Service.PHP.
Example usage:
from cocorum import chatapi
#Additionally pass username and password for to-chat interactions
chat = chatapi.ChatAPI(stream_id = STREAM_ID) #Stream ID can be base 10 or 36
chat.clear_mailbox() #Erase messages that were still visible before we connected
#Get messages for one minute
start_time = time.time()
while time.time() - start_time < 60 and (msg := chat.get_message()):
print(msg.user.username, "said", msg)
S.D.G.
ChatAPI
The Rumble internal chat API
Source code in cocorum/chatapi.py
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 |
|
session_cookie
property
The session cookie we are logged in with
stream_id_b10
property
The chat ID in use
__init__(stream_id, username=None, password=None, session=None)
The Rumble internal chat API
Parameters:
Name | Type | Description | Default |
---|---|---|---|
stream_id
|
(int, str)
|
Stream ID in base 10 or 36. |
required |
username
|
str
|
Username to login with. Defaults to no login. |
None
|
password
|
str
|
Password to log in with. Defaults to no login. |
None
|
session
|
(str, dict)
|
Session token or cookie dict to authenticate with. Defaults to getting new session with username and password. |
None
|
Source code in cocorum/chatapi.py
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 |
|
clear_deleted_message_ids()
Clear and return the list of deleted message IDs
Source code in cocorum/chatapi.py
674 675 676 677 678 |
|
clear_mailbox()
Delete anything in the mailbox
Source code in cocorum/chatapi.py
670 671 672 |
|
command(command_message)
Send a native chat command
Parameters:
Name | Type | Description | Default |
---|---|---|---|
command_message
|
str
|
The message you would send to launch this command in chat. |
required |
Returns:
Name | Type | Description |
---|---|---|
JSON |
dict
|
The JSON returned by the command. |
Source code in cocorum/chatapi.py
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 |
|
delete_message(message)
Delete a message in chat.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
message
|
int
|
Object which when converted to integer is the target message ID. |
required |
Source code in cocorum/chatapi.py
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 |
|
get_message()
Return the next chat message (parsing any additional data), waits for it to come in, returns None if chat closed
Source code in cocorum/chatapi.py
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 |
|
load_badges(jsondata)
Create our dictionary of badges from an SSE data JSON
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
A JSON data block from an SSE event. |
required |
Source code in cocorum/chatapi.py
706 707 708 709 710 711 712 713 |
|
mute_user(user, duration=None, total=False)
Mute a user.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user
|
str
|
Username to mute. |
required |
duration
|
int
|
How long to mute the user in seconds. Defaults to infinite. |
None
|
total
|
bool
|
Wether or not they are muted across all videos. Defaults to False, just this video. |
False
|
Source code in cocorum/chatapi.py
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 |
|
next_jsondata()
Wait for the next event from the SSE and parse the JSON
Source code in cocorum/chatapi.py
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 |
|
parse_init_data(jsondata)
Extract initial chat data from the SSE init event JSON
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON data returned by the initial SSE connection. |
required |
Source code in cocorum/chatapi.py
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 |
|
pin_message(message)
Pin a message
Source code in cocorum/chatapi.py
563 564 565 566 |
|
send_message(text, channel_id=None)
Send a message in chat.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text
|
str
|
The message text. |
required |
channel_id
|
int
|
Numeric ID of the channel to use. Defaults to None. |
None
|
Returns:
Name | Type | Description |
---|---|---|
ID |
int
|
The ID of the sent message. |
User |
ChatAPIUser
|
Your current chat user information. |
Source code in cocorum/chatapi.py
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 |
|
unmute_user(user)
Unmute a user.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user
|
str
|
Username to unmute |
required |
Source code in cocorum/chatapi.py
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 |
|
unpin_message(message=None)
Unpin the pinned message
Source code in cocorum/chatapi.py
568 569 570 571 572 573 574 |
|
update_channels(jsondata)
Update our dictionary of channels from an SSE data JSON
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
A JSON data block from an SSE event. |
required |
Source code in cocorum/chatapi.py
693 694 695 696 697 698 699 700 701 702 703 704 |
|
update_mailbox(jsondata)
Parse chat messages from an SSE data JSON
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
A JSON data block from an SSE event. |
required |
Source code in cocorum/chatapi.py
660 661 662 663 664 665 666 667 668 |
|
update_users(jsondata)
Update our dictionary of users from an SSE data JSON
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
A JSON data block from an SSE event. |
required |
Source code in cocorum/chatapi.py
680 681 682 683 684 685 686 687 688 689 690 691 |
|
ChatAPIChannel
Bases: ChatAPIChatter
A channel in the SSE chat
Source code in cocorum/chatapi.py
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
|
channel_id
property
The ID of this channel in base 10
channel_id_b10
property
The ID of this channel in base 10
channel_id_b36
property
The ID of this channel in base 36
is_appearing
property
Is the user of this channel still appearing as it?
user_id
property
The numeric ID of the user of this channel
user_id_b10
property
The numeric ID of the user of this channel in base 10
user_id_b36
property
The numeric ID of the user of this channel in base 36
__init__(jsondata, chat)
A channel in the internal chat API
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON data block for the channel. |
required |
chat
|
ChatAPI
|
The ChatAPI object that spawned us. |
required |
Source code in cocorum/chatapi.py
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
|
ChatAPIChatter
Bases: JSONUserAction
, ChatAPIObj
A user or channel in the internal chat API (abstract)
Source code in cocorum/chatapi.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
|
link
property
The user's subpage of Rumble.com
__init__(jsondata, chat)
A user or channel in the internal chat API (abstract)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON data block for the user/channel. |
required |
chat
|
ChatAPI
|
The ChatAPI object that spawned us. |
required |
Source code in cocorum/chatapi.py
47 48 49 50 51 52 53 54 55 |
|
ChatAPIMessage
Bases: ChatAPIObj
A single chat message in the internal chat API
Source code in cocorum/chatapi.py
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 |
|
channel
property
Reference to the channel that posted this message, if there was one
channel_id
property
The numeric ID of the channel who posted the message, if there is one
channel_id_b10
property
The ID of the channel who posted the message in base 10
channel_id_b36
property
The ID of the channel who posted the message in base 36
is_rant
property
Is this message a rant?
message_id
property
The unique numerical ID of the chat message in base 10
message_id_b10
property
The unique numerical ID of the chat message in base 10
message_id_b36
property
The unique numerical ID of the chat message in base 36
raid_notification
property
Are we a raid notification? Returns associated JSON data if yes, False if no
rant_duration
property
The duration the rant will show for, returns 0 if message is not a rant
rant_expires_on
property
When the rant expires, returns message creation time if message is not a rant
rant_price_cents
property
The price of the rant, returns 0 if message is not a rant
text
property
The text of the message
time
property
The time the message was sent on, in seconds since the Epoch UTC
user
property
Reference to the user who posted this message
user_id
property
The numerical ID of the user who posted the message in base 10
user_id_b10
property
The numeric ID of the user in base 10
user_id_b36
property
The numeric ID of the user in base 36
__eq__(other)
Compare this chat message with another
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(str, ChatAPIMessage)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/chatapi.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
|
__init__(jsondata, chat)
A single chat message in the internal chat API
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON data block for the message. |
required |
chat
|
ChatAPI
|
The ChatAPI object that spawned us. |
required |
Source code in cocorum/chatapi.py
255 256 257 258 259 260 261 262 263 264 265 266 267 |
|
__int__()
The chat message in integer (ID) form
Source code in cocorum/chatapi.py
307 308 309 |
|
__str__()
The chat message in string form
Source code in cocorum/chatapi.py
303 304 305 |
|
ChatAPIObj
Bases: JSONObj
Object in the internal chat API
Source code in cocorum/chatapi.py
32 33 34 35 36 37 38 39 40 41 42 43 |
|
__init__(jsondata, chat)
Object in the internal chat API
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON data block for the object. |
required |
chat
|
ChatAPI
|
The ChatAPI object that spawned us. |
required |
Source code in cocorum/chatapi.py
34 35 36 37 38 39 40 41 42 43 |
|
ChatAPIUser
Bases: ChatAPIChatter
User in the internal chat API
Source code in cocorum/chatapi.py
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
|
badges
property
Badges the user has
channel_id
property
The numeric channel ID that the user is appearing with in base 10
channel_id_b10
property
The numeric channel ID that the user is appearing with in base 10
channel_id_b36
property
The numeric channel ID that the user is appearing with in base 36
color
property
The color of our username (RGB tuple)
is_follower
property
Is this user following the livestreaming channel?
user_id
property
The numeric ID of the user in base 10
user_id_b10
property
The numeric ID of the user in base 10
user_id_b36
property
The numeric ID of the user in base 36
__init__(jsondata, chat)
A user in the internal chat API
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON data block for the user. |
required |
chat
|
ChatAPI
|
The ChatAPI object that spawned us. |
required |
Source code in cocorum/chatapi.py
64 65 66 67 68 69 70 71 72 73 74 |
|
__int__()
The user as an integer (it's ID in base 10)
Source code in cocorum/chatapi.py
76 77 78 |
|
ChatAPIUserBadge
Bases: ChatAPIObj
A badge of a user
Source code in cocorum/chatapi.py
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
|
icon
property
The badge's icon as a bytestring
icon_url
property
The URL of the badge's icon
label
property
A dictionary of lang:label pairs
__eq__(other)
Check if this badge is equal to another
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(str, ChatAPIUserBadge)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/chatapi.py
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
|
__init__(slug, jsondata, chat)
A user badge in the internal chat API
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON data block for the user badge. |
required |
chat
|
ChatAPI
|
The ChatAPI object that spawned us. |
required |
Source code in cocorum/chatapi.py
198 199 200 201 202 203 204 205 206 207 208 |
|
__str__()
The chat user badge in string form
Source code in cocorum/chatapi.py
228 229 230 |
|
cocorum.servicephp
Service.PHP interactions
Control Rumble via Service.PHP S.D.G.
APIComment
Bases: JSONObj
A comment on a video as returned by a successful attempt to make it
Source code in cocorum/servicephp.py
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
|
comment_id
property
The numeric ID of the comment
comment_id_b10
property
The base 10 ID of the comment
comment_id_b36
property
The base 36 ID of the comment
text
property
The text of the comment
tree_size
property
TODO
user_display
property
The display name of the user who commented
__eq__(other)
Determine if this comment is equal to another
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(int, str, APIComment)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/servicephp.py
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
|
__init__(jsondata)
A comment on a video as returned by a successful attempt to make it
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON block for a single comment. |
required |
Source code in cocorum/servicephp.py
73 74 75 76 77 78 79 80 81 82 83 84 |
|
__int__()
The comment in integer form (its ID)
Source code in cocorum/servicephp.py
86 87 88 |
|
__str__()
The comment as a string (its text)
Source code in cocorum/servicephp.py
90 91 92 |
|
APIContentVotes
Bases: JSONObj
Votes made on content
Source code in cocorum/servicephp.py
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 |
|
content_id
property
The numerical ID of the content being voted on
content_type
property
The type of content being voted on
num_votes_down
property
Downvotes on the content
num_votes_down_formatted
property
The downvotes on the content, formatted into a string
num_votes_up
property
Upvotes on the content
num_votes_up_formatted
property
The upvotes on the content, formatted into a string
score
property
Summed score of the content
score_formatted
property
The total votes on the content, formatted into a string
votes
property
The total number of votes on the content
__eq__(other)
Determine if this content votes is equal to another
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(int, str, APIContentVotes)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/servicephp.py
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
|
__int__()
The integer form of the content votes
Source code in cocorum/servicephp.py
150 151 152 |
|
__str__()
The string form of the content votes
Source code in cocorum/servicephp.py
154 155 156 |
|
APIPlaylist
Bases: JSONObj
Playlist as returned by the API
Source code in cocorum/servicephp.py
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 |
|
channel
property
The channel the playlist is under, can be None
created_on
property
The time the playlist was created in seconds since epoch
description
property
The description of the playlist
extra
property
TODO -> None, unknown
is_following
property
TODO -> Bool
items
property
The items of the playlist. TODO
num_items
property
The number of items in the playlist
permissions
property
The permissions the ServicePHP user has on this playlist
playlist_id
property
The numeric playlist ID in base 36
playlist_id_b10
property
The numeric ID of the playlist in base 10
playlist_id_b36
property
The numeric ID of the playlist in base 36
title
property
The title of the playlist
updated_on
property
The time the playlist was last updated in seconds since epoch
url
property
The URL of the playlist
visibility
property
The visibility of the playlist
__eq__(other)
Determine if this playlist is equal to another.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(int, str, APIPlaylist)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/servicephp.py
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
__init__(jsondata)
Playlist as returned by the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON data block of a playlist. |
required |
Source code in cocorum/servicephp.py
329 330 331 332 333 334 335 336 337 |
|
__int__()
The playlist as an integer (it's ID in base 10)
Source code in cocorum/servicephp.py
339 340 341 |
|
__str__()
The playlist as a string (it's ID in base 36)
Source code in cocorum/servicephp.py
343 344 345 |
|
APIUser
Bases: JSONObj
User data as returned by the API
Source code in cocorum/servicephp.py
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
|
followed
property
TODO -> Bool
followers
property
The number of followers this user has
picture
property
The user's profile picture as a bytes string
picture_url
property
The URL of the user's profile picture
user_id
property
The numeric ID of the user in base 10
user_id_b10
property
The numeric ID of the user in base 10
user_id_b36
property
The numeric ID of the user in base 36
username
property
The username of the user
verified_badge
property
Is the user verified?
__eq__(other)
Determine if this user is equal to another.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(int, str, APIUser)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/servicephp.py
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
|
__init__(jsondata)
User data as returned by the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON data block of a single user. |
required |
Source code in cocorum/servicephp.py
233 234 235 236 237 238 239 240 241 242 243 |
|
__int__()
The user as an integer (it's ID in base 10)
Source code in cocorum/servicephp.py
245 246 247 |
|
APIUserBadge
Bases: JSONObj
A badge of a user as returned by the API
Source code in cocorum/servicephp.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
|
icon
property
The badge's icon as a bytestring
icon_url
property
The URL of the badge's icon
label
property
A dictionary of lang:label pairs
__eq__(other)
Check if this badge is equal to another.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(str, APIUserBadge)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/servicephp.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
|
__init__(slug, jsondata)
A badge of a user as returned by the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
slug
|
str
|
The string identifier of the badge. |
required |
jsondata
|
dict
|
The JSON data block of the badge. |
required |
Source code in cocorum/servicephp.py
16 17 18 19 20 21 22 23 24 25 26 |
|
__str__()
The chat user badge in string form (its slug)
Source code in cocorum/servicephp.py
46 47 48 |
|
ServicePHP
Interact with Rumble's service.php API
Source code in cocorum/servicephp.py
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 |
|
user_id
property
The numeric ID of the logged in user in base 10
user_id_b10
property
The numeric ID of the logged in user in base 10
user_id_b36
property
The numeric ID of the logged in user in base 36
__init__(username, password=None, session=None)
Interact with Rumble's service.php API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
username
|
str
|
The username we will be under. |
required |
password
|
str
|
The password to use at login. Defaults to using the session token/cookie instead. |
None
|
session
|
(str, dict)
|
The session token or cookie dict to authenticate with. Defaults to using the password instead. |
None
|
Source code in cocorum/servicephp.py
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 |
|
chat_pin(stream_id, message, unpin=False)
Pin or unpin a message in a chat.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
stream_id
|
(int, str)
|
ID of the stream in base 10 or 36. |
required |
message
|
int
|
Converting this to int must return a chat message ID. |
required |
unpin
|
bool
|
If true, unpins a message instead of pinning it. |
False
|
Source code in cocorum/servicephp.py
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 |
|
comment_add(video_id, comment, reply_id=0)
Post a comment on a video.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
video_id
|
(int, str)
|
The numeric ID of a video / stream in base 10 or 36. |
required |
comment
|
str
|
What to say. |
required |
reply_id
|
int
|
The ID of the comment to reply to. Defaults to zero (don't reply to anybody). |
0
|
Returns:
Name | Type | Description |
---|---|---|
Comment |
APIComment
|
The comment, as parsed from the response data. |
Source code in cocorum/servicephp.py
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 |
|
comment_delete(comment_id)
Delete a comment by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
comment_id
|
int
|
The numeric ID of the comment to delete. |
required |
Source code in cocorum/servicephp.py
701 702 703 704 705 706 707 708 709 710 711 |
|
comment_list(video_id)
Get the list of comments under a video.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
video_id
|
(str, int)
|
The numeric ID of a video in base 10 or 36. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comments |
list
|
A list of scraping.HTMLComment objects. |
Source code in cocorum/servicephp.py
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 |
|
comment_pin(comment_id, unpin=False)
Pin or unpin a comment by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
comment_id
|
int
|
The numeric ID of the comment to pin/unpin. |
required |
unpin
|
bool
|
If true, unpins instead of pinning comment. |
False
|
Source code in cocorum/servicephp.py
688 689 690 691 692 693 694 695 696 697 698 699 |
|
comment_restore(comment_id)
Restore a deleted comment by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
comment_id
|
int
|
The numeric ID of the comment to restore. |
required |
Source code in cocorum/servicephp.py
713 714 715 716 717 718 719 720 721 722 723 724 |
|
get_video_url(video_id)
Get the URL of a Rumble video.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
video_id
|
(int, str)
|
The numeric ID of the video. |
required |
Returns:
Name | Type | Description |
---|---|---|
URL |
str
|
The URL of the video. |
Source code in cocorum/servicephp.py
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 |
|
login(username, password)
Log in to Rumble
Parameters:
Name | Type | Description | Default |
---|---|---|---|
username
|
str
|
Username to sign in with. |
required |
password
|
str
|
Password to sign in with. |
required |
Returns:
Name | Type | Description |
---|---|---|
Cookie |
dict
|
Cookie dict to be passed with requests, which authenticates them. |
Source code in cocorum/servicephp.py
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 |
|
mute_user(username, is_channel=False, video=None, duration=None, total=False)
Mute a user or channel by name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
username
|
str
|
The user to mute. |
required |
is_channel
|
bool
|
Is this a channel name rather than a username? |
False
|
video
|
int
|
The video to mute the user on. Defaults to None. |
None
|
duration
|
int
|
How long the user will be muted for, in seconds. Defaults to infinity. |
None
|
total
|
bool
|
Is this a mute across all videos? Defaults to False, requires video if False. |
False
|
Source code in cocorum/servicephp.py
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 |
|
playlist_add(title, description='', visibility='public', channel_id=None)
Create a new playlist.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
title
|
str
|
The title of the playlist. |
required |
description
|
str
|
Describe the playlist. Defaults to nothing. |
''
|
visibility
|
str
|
Set to public, unlisted, or private via string. Defaults to 'public'. |
'public'
|
channel_id
|
(int, str)
|
The ID of the channel to create the playlist under. Defaults to none. |
None
|
Returns:
Name | Type | Description |
---|---|---|
Playlist |
APIPlaylist
|
The playlist as parsed from the response data. |
Source code in cocorum/servicephp.py
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 |
|
playlist_add_video(playlist_id, video_id)
Add a video to a playlist.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
playlist_id
|
str
|
The numeric ID of the playlist in base 36. |
required |
video_id
|
(int, str)
|
The numeric ID of the video to add, in base 10 or 36. |
required |
Source code in cocorum/servicephp.py
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 |
|
playlist_delete(playlist_id)
Delete a playlist.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
playlist_id
|
str
|
The numeric ID of the playlist to delete in base 36. |
required |
Source code in cocorum/servicephp.py
855 856 857 858 859 860 861 862 863 864 865 |
|
playlist_delete_video(playlist_id, video_id)
Remove a video from a playlist.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
playlist_id
|
str
|
The numeric ID of the playlist in base 36. |
required |
video_id
|
(int, str)
|
The numeric ID of the video to remove, in base 10 or 36. |
required |
Source code in cocorum/servicephp.py
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 |
|
playlist_edit(playlist_id, title, description='', visibility='public', channel_id=None)
Edit the details of an existing playlist
Parameters:
Name | Type | Description | Default |
---|---|---|---|
playlist_id
|
str
|
The numeric ID of the playlist to edit in base 36. |
required |
title
|
str
|
The title of the playlist. |
required |
description
|
str
|
Describe the playlist. Defaults to nothing. |
''
|
visibility
|
str
|
Set to public, unlisted, or private via string. Defaults to 'public'. |
'public'
|
channel_id
|
(int, str)
|
The ID of the channel to create the playlist under. Defaults to none. |
None
|
Returns:
Name | Type | Description |
---|---|---|
Playlist |
APIPlaylist
|
The playlist as parsed from the response data. |
Source code in cocorum/servicephp.py
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 |
|
raid_confirm(stream_id)
Confirm a raid, previously set up by command.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
stream_id
|
(int, str)
|
The numeric ID of the stream to confirm the raid from, in base 10 or 36. |
required |
Source code in cocorum/servicephp.py
867 868 869 870 871 872 873 874 875 876 877 |
|
rumbles(vote, item_id, item_type)
Post a like or dislike.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
vote
|
int
|
-1, 0, or 1 (0 means clear vote). |
required |
item_id
|
int
|
The numeric ID of whatever we are liking or disliking. |
required |
item_type
|
int
|
1 for video, 2 for comment. |
required |
Source code in cocorum/servicephp.py
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 |
|
sphp_request(service_name, data={}, additional_params={}, logged_in=True, method='POST')
Make a request to Service.PHP with common settings service_name: The name parameter of the specific PHP service data: Form data additional_params: Any additional query string parameters logged_in: The request should use the session cookie
Source code in cocorum/servicephp.py
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 |
|
unmute_user(record_id)
Unmute a user.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
record_id
|
int
|
The numeric ID of the mute record to undo. |
required |
Source code in cocorum/servicephp.py
617 618 619 620 621 622 623 624 625 626 627 628 629 |
|
cocorum.uploadphp
UploadPHP
Interact with Rumble's Upload.PHP API to upload videos. S.D.G.
UploadPHP
Upload videos to Rumble
Source code in cocorum/uploadphp.py
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
|
session_cookie
property
Our Rumble session cookie to authenticate requests
__init__(servicephp)
Upload videos to Rumble.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
servicephp
|
ServicePHP
|
ServicePHP object, for authentication. |
required |
Source code in cocorum/uploadphp.py
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
|
chunked_vidfile_upload(file_path)
Upload a video file to Rumble in chunks
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path
|
str
|
A valid, complete path to the video file for upload. |
required |
Returns:
Name | Type | Description |
---|---|---|
Filename |
str
|
The filename of the merged video on the server after upload. |
Source code in cocorum/uploadphp.py
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
|
ensure_valid_channel_id(channel_id)
Ensure a channel ID is numeric and a valid channel, or None
Parameters:
Name | Type | Description | Default |
---|---|---|---|
channel_id
|
(int, None)
|
The numeric ID of the channel. |
required |
Returns:
Name | Type | Description |
---|---|---|
Result |
(int, None)
|
Either the confirmed channel ID, or None if it didn't exist / wasn't specified. |
Source code in cocorum/uploadphp.py
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
|
get_categories()
Load the primary and secondary categories from Rumble
Source code in cocorum/uploadphp.py
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
|
unchunked_vidfile_upload(file_path)
Upload a video file to Rumble all at once
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path
|
str
|
A valid, complete path to the video file for upload. |
required |
Returns:
Name | Type | Description |
---|---|---|
Filename |
str
|
The filename of the video on the server after upload. |
Source code in cocorum/uploadphp.py
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
uphp_request(additional_params, method='PUT', data=None, timeout=static.Delays.request_timeout)
Make a request to Upload.PHP with common settings.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
additional_params
|
dict
|
Query string parameters to add to the base ones |
required |
method
|
str
|
What HTTP method to use for the request. Defaults to PUT. |
'PUT'
|
data
|
dict
|
Form data for the request. Defaults to None. |
None
|
timeout
|
(int, float)
|
Request timeout. Defaults to static.Delays.request_timeout |
request_timeout
|
Returns:
Name | Type | Description |
---|---|---|
Response |
Response
|
The response from the request. |
Source code in cocorum/uploadphp.py
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
|
upload_cthumb(file_path)
Upload a custom thumbnail for a video
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path
|
str
|
A valid, complete path to the image file for upload. |
required |
Returns:
Name | Type | Description |
---|---|---|
Filename |
str
|
Filename of the image on the server after upload. |
Source code in cocorum/uploadphp.py
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
|
upload_video(file_path, title, category1, **kwargs)
Upload a video to Rumble
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path
|
str
|
A valid, complete path to a video file. |
required |
title
|
str
|
The video title. |
required |
category1
|
(int, str)
|
The primary category to upload to, by name or numeric ID. |
required |
description
|
str
|
Describe the video. Defaults to empty. |
required |
info_who
|
str
|
Additional people appearing in the video. Defaults to empty. |
required |
info_when
|
str
|
When this video was recorded. Defaults to unspecified. |
required |
info_where
|
str
|
Where this video was recorded. Defaults to unspecified. |
required |
info_ext_user
|
str
|
Your username on other platforms. Defaults to unspecified. |
required |
tags
|
str
|
Comma-separated tagging for the video's topics. Defaults to empty. |
required |
category2
|
(int, str)
|
The secondary category to upload to, by name or numeric ID. Defaults to empty |
required |
channel_id
|
(int, str)
|
Numeric ID or name of the channel to upload to. Defaults to user page upload. |
required |
visibility
|
str
|
Visibility of the video, either public, unlisted, or private. Defaults to 'public'. |
required |
availability
|
TODO Defaults to free. |
required | |
scheduled_publish
|
(int, float)
|
When to publish the video to public later, in seconds since epoch. Defaults to publish immediately. |
required |
thumbnail
|
(int, str)
|
Thumbnail to use. Index 0-2 for an auto thumbnail, or a complete, valid local file path for custom. Defaults to 0, first auto thumbnail. |
required |
Returns:
Name | Type | Description |
---|---|---|
Response |
UploadResponse
|
Data about the upload, parsed from the response. |
Source code in cocorum/uploadphp.py
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
|
UploadResponse
Bases: JSONObj
Response to a successful video upload
Source code in cocorum/uploadphp.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
|
embed
property
HTML to use for embedding the video
embed_monetize
property
HTML to use for embedding the video with monetization
fid
property
The numeric ID of the uploaded video in base 10
fid_b10
property
The numeric ID of the uploaded video in base 10
fid_b36
property
The numeric ID of the uploaded video in base 36
title
property
The title of the video
url
property
The video viewing URL
cocorum.scraping
Scraping for Cocorum
Classes and utilities for extracting data from HTML, including that returned by the API. S.D.G.
HTMLChannel
Bases: HTMLObj
Channel under a user as extracted from their channels page
Source code in cocorum/scraping.py
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 |
|
channel_id
property
The numeric ID of the channel in base 10
channel_id_b10
property
The numeric ID of the channel in base 10
channel_id_b36
property
The numeric ID of the channel in base 36
slug
property
The unique string ID of the channel
title
property
The title of the channel
__eq__(other)
Determine if this channel is equal to another.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(int, str, HTMLChannel)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/scraping.py
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 |
|
__int__()
The channel as an integer (its numeric ID)
Source code in cocorum/scraping.py
394 395 396 |
|
__str__()
The channel as a string (its slug)
Source code in cocorum/scraping.py
390 391 392 |
|
HTMLComment
Bases: HTMLObj
A comment on a video as returned by service.php comment.list
Source code in cocorum/scraping.py
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
|
actions
property
Allowed actions on this comment based on the login used to retrieve it
comment_id
property
The numeric ID of the comment in base 10
comment_id_b10
property
The base 10 ID of the comment
comment_id_b36
property
The base 36 ID of the comment
entity_type
property
Wether the comment was made by a user or a channel
is_first
property
Is this comment the first one?
rumbles
property
The votes on this comment
text
property
The text of the comment
username
property
The name of the user who commented
video_id
property
The base 10 ID of the video the comment was posted on
video_id_b10
property
The base 10 ID of the video the comment was posted on
video_id_b36
property
The base 36 ID of the video the comment was posted on
__eq__(other)
Determine if this comment is equal to another.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(int, str, HTMLComment)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/scraping.py
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
|
__init__(elem)
A comment on a video as returned by service.php comment.list
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elem
|
Tag
|
The |
required |
Source code in cocorum/scraping.py
91 92 93 94 95 96 97 98 99 100 101 102 |
|
__int__()
The comment in integer form (its ID)
Source code in cocorum/scraping.py
104 105 106 |
|
__str__()
The comment as a string (its text)
Source code in cocorum/scraping.py
108 109 110 |
|
HTMLContentVotes
Bases: HTMLObj
Votes made on content
Source code in cocorum/scraping.py
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
|
content_id
property
The numerical ID of the content being voted on
content_type
property
The type of content being voted on
score
property
Summed score of the content
__eq__(other)
Determine if this content votes is equal to another.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(int, str, HTMLContentVotes)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/scraping.py
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
|
__int__()
The integer form of the content votes
Source code in cocorum/scraping.py
199 200 201 |
|
__str__()
The string form of the content votes
Source code in cocorum/scraping.py
203 204 205 206 |
|
HTMLObj
Abstract object scraped from bs4 HTML
Source code in cocorum/scraping.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
|
__getitem__(key)
Get a key from the element attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
A valid attribute name. |
required |
Source code in cocorum/scraping.py
23 24 25 26 27 28 29 30 |
|
__init__(elem)
Abstract object scraped from bs4 HTML
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elem
|
Tag
|
The BeautifulSoup element to base our data on. |
required |
Source code in cocorum/scraping.py
14 15 16 17 18 19 20 21 |
|
HTMLPlaylist
Bases: HTMLObj
A playlist as obtained from HTML data
Source code in cocorum/scraping.py
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
|
channel_url
property
The URL of the base user or channel the playlist under
description
property
The description of the playlist
is_under_channel
property
Is this playlist under a channel?
num_items
property
The number of items in the playlist
playlist_id
property
The numeric ID of the playlist in base 36
playlist_id_b10
property
The numeric ID of the playlist in base 10
playlist_id_b36
property
The numeric ID of the playlist in base 36
thumbnail
property
The playlist thumbnail as a binary string
thumbnail_url
property
The url of the playlist's thumbnail image
title
property
The title of the playlist
url
property
The URL of the playlist page
visibility
property
The visibility of the playlist
__eq__(other)
Determine if this playlist is equal to another.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(int, str, HTMLPlaylist)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/scraping.py
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
|
__init__(elem, scraper)
A playlist as obtained from HTML data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elem
|
Tag
|
The playlist class = "thumbnail__grid-item" element. |
required |
scraper
|
Scraper
|
The HTML scraper object that spawned us. |
required |
Source code in cocorum/scraping.py
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
|
__int__()
The playlist as an integer (it's ID in base 10)
Source code in cocorum/scraping.py
270 271 272 |
|
__str__()
The playlist as a string (it's ID in base 36)
Source code in cocorum/scraping.py
274 275 276 |
|
HTMLUserBadge
Bases: HTMLObj
A user badge as extracted from a bs4 HTML element
Source code in cocorum/scraping.py
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
|
icon
property
The badge's icon as a bytestring
icon_url
property
The URL of the badge's icon
label
property
The string label of the badge in whatever language the Service.PHP agent used
__eq__(other)
Check if this badge is equal to another.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(str, HTMLUserBadge)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/scraping.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
|
__init__(elem)
A user badge as extracted from a bs4 HTML element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elem
|
Tag
|
The badge |
required |
Source code in cocorum/scraping.py
34 35 36 37 38 39 40 41 42 43 |
|
__str__()
The chat user badge in string form
Source code in cocorum/scraping.py
63 64 65 |
|
HTMLVideo
Bases: HTMLObj
Video on a user or channel page as extracted from the page's HTML
Source code in cocorum/scraping.py
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 |
|
thumbnail
property
The video thumbnail as a binary string
thumbnail_url
property
The URL of the video's thumbnail image
title
property
The title of the video
upload_date
property
The time that the video was uploaded, in seconds since epoch
video_id
property
The numeric ID of the video in base 10
video_id_b10
property
The numeric ID of the video in base 10
video_id_b36
property
The numeric ID of the video in base 36
video_url
property
The URL of the video's viewing page
__eq__(other)
Determine if this video is equal to another.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(int, str, HTMLVideo)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/scraping.py
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
|
__init__(elem)
Video on a user or channel page as extracted from the page's HTML.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elem
|
Tag
|
The class = "thumbnail__grid-item" video element. |
required |
Source code in cocorum/scraping.py
451 452 453 454 455 456 457 458 459 460 461 |
|
__int__()
The video as an integer (it's numeric ID)
Source code in cocorum/scraping.py
463 464 465 |
|
__str__()
The video as a string (it's ID in base 36)
Source code in cocorum/scraping.py
467 468 469 |
|
Scraper
Scraper for general information
Source code in cocorum/scraping.py
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 |
|
session_cookie
property
The session cookie we are logged in with
username
property
Our username
__init__(servicephp)
Scraper for general information.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
servicephp
|
ServicePHP
|
A ServicePHP instance, for authentication. |
required |
Source code in cocorum/scraping.py
545 546 547 548 549 550 551 552 |
|
get_channels(username=None)
Get all channels under a username.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
username
|
str
|
The username to get the channels under. Defaults to None, use our own username. |
None
|
Returns:
Name | Type | Description |
---|---|---|
Channels |
list
|
List of HTMLChannel objects. |
Source code in cocorum/scraping.py
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 |
|
get_muted_user_record(username=None)
Get the record IDs for mutes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
username
|
str
|
Username to find record ID for. Defaults to None. |
None
|
Returns:
Name | Type | Description |
---|---|---|
Record |
(int, dict)
|
Either the single user's mute record ID, or a dict of all username:mute record ID pairs. |
Source code in cocorum/scraping.py
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 |
|
get_playlists()
Get the playlists under the logged in user
Source code in cocorum/scraping.py
697 698 699 700 |
|
get_videos(username=None, is_channel=False, max_num=None)
Get the videos under a user or channel.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
username
|
str
|
The name of the user or channel to search under. Defaults to ourselves. |
None
|
is_channel
|
bool
|
Is this a channel instead of a userpage? Defaults to False. |
False
|
max_num
|
int
|
The maximum number of videos to retrieve, starting from the newest. Defaults to None, return all videos. Note, rounded up to the nearest page. |
None
|
Returns:
Name | Type | Description |
---|---|---|
Videos |
list
|
List of HTMLVideo objects. |
Source code in cocorum/scraping.py
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 |
|
soup_request(url)
Make a GET request to a URL, and return HTML beautiful soup for scraping.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
url
|
str
|
The URL to query. |
required |
Returns:
Name | Type | Description |
---|---|---|
Soup |
BeautifulSoup
|
The webpage at the URL, logged-in version. |
Source code in cocorum/scraping.py
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
|
cocorum.jsonhandles
JSON handles
Abstract classes for handling JSON data. S.D.G.
JSONObj
Abstract class for handling a JSON data block as an object
Source code in cocorum/jsonhandles.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
|
get
property
Get a key from the JSON with fallback
__getitem__(key)
Get a key from the JSON
Source code in cocorum/jsonhandles.py
21 22 23 |
|
__init__(jsondata)
Abstract class for handling a JSON data block as an object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON data block of an API object. |
required |
Source code in cocorum/jsonhandles.py
12 13 14 15 16 17 18 19 |
|
JSONUserAction
Bases: JSONObj
Abstract class for Rumble JSON user actions
Source code in cocorum/jsonhandles.py
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
|
profile_pic
property
The user's profile picture as a bytes string
profile_pic_url
property
The user's profile picture URL
username
property
The username
__eq__(other)
Is this user equal to another?
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other
|
(str, JSONUserAction)
|
Object to compare to. |
required |
Returns:
Name | Type | Description |
---|---|---|
Comparison |
(bool, None)
|
Did it fit the criteria? |
Source code in cocorum/jsonhandles.py
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
|
__init__(jsondata)
Abstract class for Rumble JSON user actions.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondata
|
dict
|
The JSON block for a single Rumble user action. |
required |
Source code in cocorum/jsonhandles.py
32 33 34 35 36 37 38 39 40 |
|
__str__()
Follower as a string
Source code in cocorum/jsonhandles.py
69 70 71 |
|
cocorum.utils
Rumble API utilities
This submodule provides some utilities for working with the APIs S.D.G.
MD5Ex
MD5 extended hashing utilities
Source code in cocorum/utils.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
|
hash(message)
staticmethod
Hash a string.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
message
|
str
|
Message to hash. |
required |
Returns:
Name | Type | Description |
---|---|---|
Hash |
str
|
The hex digest hash result. |
Source code in cocorum/utils.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
|
hash_stretch(password, salt, iterations=1024)
staticmethod
Stretch-hash a password with a salt.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
password
|
str
|
The password to hash. |
required |
salt
|
str
|
The salt to add to the password. |
required |
iterations
|
int
|
Number of times to stretch the hashing. |
1024
|
Returns:
Name | Type | Description |
---|---|---|
Hash |
str
|
The completed stretched hash. |
Source code in cocorum/utils.py
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
|
badges_to_glyph_string(badges)
Convert a list of badges into a string of glyphs.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
badges
|
list
|
A list of str or objects with str method that are valid badge slugs. |
required |
Returns:
Name | Type | Description |
---|---|---|
Glyphs |
str
|
The badge list as a UTF-8 glyph string, uses ? for unknown badges. |
Source code in cocorum/utils.py
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
|
base_10_to_36(b10)
Convert a base 10 number to base 36.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
b10
|
int
|
The base 10 number. |
required |
Returns:
Name | Type | Description |
---|---|---|
B36 |
str
|
The same number in base 36. |
Source code in cocorum/utils.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
|
base_36_and_10(num, assume_10=False)
Take a base 36 or base 10 number, and return both base 36 and 10.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
num
|
(int, str)
|
The number in either base 10 or 36. |
required |
assume_10
|
bool
|
If the number is a string but looks like base 10, should we assume it is? Defaults to False. |
False
|
Returns:
Name | Type | Description |
---|---|---|
B36 |
str
|
The number in base 36. |
B10 |
int
|
The number in base 10. |
Source code in cocorum/utils.py
170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
|
base_36_to_10(b36)
Convert a base 36 number to base 10.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
b36
|
str
|
The base 36 number. |
required |
Returns:
Name | Type | Description |
---|---|---|
B10 |
int
|
The same number in base 10. |
Source code in cocorum/utils.py
104 105 106 107 108 109 110 111 112 113 114 |
|
calc_password_hashes(password, salts)
Hash a password for Rumble authentication.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
password
|
str
|
The password to hash. |
required |
salts
|
iter
|
The three salts to use for hashing. |
required |
Returns:
Name | Type | Description |
---|---|---|
Hashes |
iter
|
The three results of hashing. |
Source code in cocorum/utils.py
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
|
ensure_b10(num, assume_10=False)
No matter wether a number is base 36 or 10, return 10.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
num
|
(int, str)
|
The number in either base 10 or 36. |
required |
assume_10
|
bool
|
If the number is a string but looks like base 10, should we assume it is? Defaults to False. |
False
|
Returns:
Name | Type | Description |
---|---|---|
Number |
int
|
The number in base 10. |
Source code in cocorum/utils.py
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
|
ensure_b36(num, assume_10=False)
No matter wether a number is base 36 or 10, return 36.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
num
|
(int, str)
|
The number in either base 10 or 36. |
required |
assume_10
|
bool
|
If the number is a string but looks like base 10, should we assume it is? Defaults to False. |
False
|
Returns:
Name | Type | Description |
---|---|---|
Number |
str
|
The number in base 36. |
Source code in cocorum/utils.py
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
|
form_timestamp(seconds, suffix='+00:00')
Form a Rumble timestamp.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
seconds
|
float
|
Timestamp in seconds since Epoch, UTC. |
required |
Returns:
Name | Type | Description |
---|---|---|
Timestamp |
str
|
The same timestamp value, in Rumble's API format. |
Source code in cocorum/utils.py
73 74 75 76 77 78 79 80 81 82 83 |
|
generate_request_id()
Generate a UUID for API requests
Returns:
Name | Type | Description |
---|---|---|
UUID |
str
|
Random base64 encoded UUID. |
Source code in cocorum/utils.py
226 227 228 229 230 231 232 233 234 235 |
|
options_check(url, method, origin=static.URI.rumble_base, cookies={}, params={})
Check of we are allowed to do method on url via an options request
Parameters:
Name | Type | Description | Default |
---|---|---|---|
url
|
str
|
The URL to check at. |
required |
method
|
str
|
The HTTP method to check permission for. |
required |
origin
|
str
|
The origin header of the options request. Defaults to static.URI.rumble_base |
rumble_base
|
cookies
|
dict
|
Cookie dict to use in the request. Defaults to no cookies. |
{}
|
params
|
dict
|
Parameters to use in the request. Defaults to no parameters. |
{}
|
Returns:
Name | Type | Description |
---|---|---|
Result |
bool
|
Is the HTTP method allowed at the URL? |
Source code in cocorum/utils.py
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
|
parse_timestamp(timestamp)
Parse a Rumble timestamp.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
timestamp
|
str
|
Timestamp in Rumble's API format. |
required |
Returns:
Name | Type | Description |
---|---|---|
Timestamp |
float
|
The same timestamp value, in seconds since Epoch, UTC. |
Source code in cocorum/utils.py
60 61 62 63 64 65 66 67 68 69 70 71 |
|
test_session_cookie(session_cookie)
Test if a session cookie dict is valid.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session_cookie
|
dict
|
The session cookie dict to test. |
required |
Returns:
Name | Type | Description |
---|---|---|
Result |
bool
|
Is the cookie dict valid? |
Source code in cocorum/utils.py
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
|
cocorum.static
Cocorum static variable definitions
Provides various data that, if changed, would need to change globally.
S.D.G.
Delays
Various times for delays and waits
Source code in cocorum/static.py
73 74 75 76 77 78 79 80 81 82 83 |
|
Message
For chat messages
Source code in cocorum/static.py
85 86 87 88 89 90 91 92 93 94 95 |
|
Misc
No idea where else to put this data
Source code in cocorum/static.py
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
|
ContentTypes
Types of content that can be rumbled on
Source code in cocorum/static.py
139 140 141 142 143 144 145 146 |
|
RequestHeaders
Headers for various HTTPrequests
Source code in cocorum/static.py
8 9 10 11 12 13 14 15 |
|
StaticAPIEndpoints
API endpoints that don't change and shouldn't trigger a refresh
Source code in cocorum/static.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
|
URI
URIs to various Rumble services
Source code in cocorum/static.py
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
|
ChatAPI
URIs of the chat API
Source code in cocorum/static.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
|
Upload
Data relating to uploading videos
Source code in cocorum/static.py
97 98 99 100 101 102 103 104 105 106 |
|
S.D.G.