Skip to main content

vtuberwiki-py is a Python wrapper for VirtualYoutuber Fandom API.

Project description

vtuberwiki-py

vtuberwiki-py is a Python library wrapper for VirtualYoutuber Fandom API.

This package supports both Asynchronous (async/non-blocking) and Synchronous (sync/blocking) programming.

Installation

To install vtuberwiki-py, simply run:

$ pip install vtuberwiki-py

Breaking Changes

Here is some of the breaking changes for vtuberwiki-py 0.1.7 :

  • to increase ease of use, auto_correct parameter will now defaults to True
  • trivia() now returns a List
  • removing misc and name key from dict, so trivia() will now fetch all of the trivia without classifying the segment
  • background() method is now changed into history()
  • adding a new quote() method to fetch vtuber's quotes
  • quote() method returns a List
  • now you can get the name & image of a Vtuber by calling the .name and .image Class property

to understand more please read vtuberwiki-py documentations, thanks.

Documentation

You can find the full documentation and example for vtuberwiki-py here.

Examples

→ Asynchronous (non-blocking)

from vtuberwiki import AioVwiki
import asyncio

async def search_fandom():
    async with AioVwiki() as aio_vwiki:
        await aio_vwiki.search(vtuber="mythia batford",limit=3)
        # ['Mythia Batford', 'Mythia Batford/Gallery', 'Mythia Batford/Discography']
        await aio_vwiki.summary(vtuber="mythia batford",auto_correct=True)
        # Mythia Batford (ミシア ・バットフォード) is an Indonesian female Virtual Youtuber. She uses both Indonesian and English on her stream.

asyncio.run(search_fandom())

→ Synchronous (blocking)

from vtuberwiki import Vwiki

def search_fandom():
    vwiki = Vwiki()
    vwiki.search(vtuber="mythia batford",limit=3)
    # ['Mythia Batford', 'Mythia Batford/Gallery', 'Mythia Batford/Discography']
    vwiki.summary(vtuber="mythia batford",auto_correct=True)
    # Mythia Batford (ミシア ・バットフォード) is an Indonesian female Virtual Youtuber. She uses both Indonesian and English on her stream.

search_fandom()

License

MIT licensed. See the LICENSE file for full details.

Credits

  • Special thanks to MediaWiki API and Fandom for making this project possible

Project details


Download files

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

Source Distribution

vtuberwiki-py-0.1.8.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

vtuberwiki_py-0.1.8-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file vtuberwiki-py-0.1.8.tar.gz.

File metadata

  • Download URL: vtuberwiki-py-0.1.8.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.1

File hashes

Hashes for vtuberwiki-py-0.1.8.tar.gz
Algorithm Hash digest
SHA256 343dfcac1308ef8bd3bd862fb0f6cd1a29cb0e1555ab65cb80c4611295a40ca5
MD5 3327cf5508ae9defc05b5f58767a718f
BLAKE2b-256 efd671ab2c7084b1ad9361ce0d992cb1c5e259181a8ce2b0657832aafd7b240b

See more details on using hashes here.

File details

Details for the file vtuberwiki_py-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: vtuberwiki_py-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.1

File hashes

Hashes for vtuberwiki_py-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 8658a57ed6b863fbbcb19ac5ea1500b0e73d100701b17471644fe6e66056ac3a
MD5 144b25e164ee8364fb22d9a9eaa4608e
BLAKE2b-256 a04507e517c33dd2e777722a992b886046e7e3216a99d00061f8f1d55e2c6f75

See more details on using hashes here.

Supported by

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