Quick Start

here is what you need to know to start using the packages:

Installation

You can start by installing the package with:

pip install vtuberwiki-py

Importing the module

We start by importing classes from vtuberwiki module into our project.

from vtuberwiki import AioVwiki # for asynchronous
from vtuberwiki import Vwiki # for synchronous

Example use cases

Lets say you wanted to search for an available Vtuber Fandom page, all you need to do is to use the search() method.

Async (non-blocking)

from vtuberwiki import AioVwiki
import asyncio

async def search_fandom():
    async with AioVwiki() as aio_vwiki:
        s = await aio_vwiki.search(vtuber="mythia batford",limit=3)
        print(s) #['Mythia Batford', 'Mythia Batford/Gallery', 'Mythia Batford/Discography']

asyncio.run(search_fandom())

Sync (blocking)

from vtuberwiki import Vwiki
import asyncio

def search_fandom():
    vwiki = Vwiki()
    s = vwiki.search(vtuber="mythia batford",limit=3)
    print(s) #['Mythia Batford', 'Mythia Batford/Gallery', 'Mythia Batford/Discography']

search_fandom()

Note: the most relevant search is usually the first index

Hmm, how about if you want to fetch the data for the Fandom itself, in this case, the summary? well, in that case, use the summary() method.

Async (non-blocking)

from vtuberwiki import AioVwiki
import asyncio

async def get_summary():
    async with AioVwiki() as aio_vwiki:
        s = await aio_vwiki.summary(vtuber="mythia batford",auto_correct=True)
        print(s) #Mythia Batford (ミシア ・バットフォード) is an Indonesian female Virtual Youtuber. She uses both Indonesian and English on her stream.

asyncio.run(get_summary())

Sync (blocking)

from vtuberwiki import Vwiki

def get_summary():
    vwiki = Vwiki()
    s = vwiki.summary(vtuber="mythia batford",limit=3)
    print(s) #Mythia Batford (ミシア ・バットフォード) is an Indonesian female Virtual Youtuber. She uses both Indonesian and English on her stream.

get_summary()

And now you have a basic understanding of what you can do with fvtuberwiki-py. Do check out the rest of the documentation if you want to know more about the other method.