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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

Supported by

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