Wikidot Utility Library
Project description
wikidot.py - A Python library for making requests to the Wikidot sites.
Installation
pip install wikidot
Usage
[!NOTE] You can use this library without logging in, but you can only use the features that do not require logging in.
import wikidot
# Create a new Client class and logging in with the credentials of your wikidot account
# If you don't want to log in : with wikidot.Client() as client:
with wikidot.Client(username='input-your-name', password='input-your-password') as client:
# ------
# user features
# ------
# Get the user object of the user
user = client.user.get('input-a-username')
# Bulk execution by asynchronous request
users = client.user.get_bulk(['input-a-username', 'input-another-username'])
# ------
# site features
# ------
# Get the site object of the SCP Foundation
site = client.site.get('scp-wiki')
# invite a user to the site
site.invite_user(user)
# Get all unprocessed applications for the site
applications = site.get_applications()
# process an application
for application in applications:
application.accept()
# or
application.reject()
# ------
# page features
# ------
# Search pages by some criteria
# NOTE: The search criteria are the same as in the ListPages module
pages = site.pages.search(
category="_default",
tags=["tag1", "tag2"], # You can also use the "tag1 -tag2" syntax
order="created_at desc desc",
limit=10,
)
# Get the page object of the SCP-001
page = site.page.get('scp-001')
# destroy a page
page.destroy()
# ------
# private message features
# ------
# Get messages in your inbox
received_messages = client.private_message.get_inbox()
# Get messages in your sent box
sent_messages = client.private_message.get_sentbox()
# Get message by id
# NOTE: You can only get the message that you have received or sent
message = client.private_message.get(123456)
# Bulk execution by asynchronous request
messages = client.private_message.get_messages([123456, 123457])
# Send a message to a user
client.private_message.send(
recipient=user,
subject='Hello',
body='Hello, world!'
)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
wikidot-3.1.0.dev6.tar.gz
(30.1 kB
view hashes)
Built Distribution
Close
Hashes for wikidot-3.1.0.dev6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 728a02cb7c7e319a2df1c85b471b9518745c2c516ce2bf9348270d7495db8f7f |
|
MD5 | 3d4412289f6de84d4689e98f7d9d5d4b |
|
BLAKE2b-256 | f35edc90767ad2d293bdc02a0fa5301c4d9fb097a3e085dd7ac53cb71d2f4415 |