Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 2.4 KB

README.rst

File metadata and controls

74 lines (48 loc) · 2.4 KB

Vichan Python Library

The Bibliotheca Anonoma's complete Python Wrapper for the Vichan API. Uses requests, respects if-modified-since headers on updating threads. Caches thread objects. Fun stuff.

An absolute must if you want to interface with or scrape from 8chan or other vichan-based imageboards/textboards, using a Python script._

Hosted Documentation

Github Repository

You can install this library straight from PyPi with:

pip install pyvichan

Getting Help

If you want help, or you have some trouble using this library, our primary IRC channel is #bibanon on irc.rizon.net. Simply head in there and talk to dan or antonizoon. Otherwise, you can put a issue on our Github Issue Tracker and we'll respond as soon as we can!


Usage

import pyvichan
v = pyvichan.Board('v', '8kun.top')
thread = v.get_thread(16959924)

print(thread)

# supports displaying extra files in one post as well!
for file in thread.file_objects():
    print(file.file_url)

# In a while...
print("I fetched", thread.update(), "new replies.")

Documentation

This library mostly extends the classes of BASC-py4chan, but has some differences. There are some, but few diffrerences between py8chan and pyvichan. For now, refer to the py8chan documentation for more info.

py8chan Documentation

Notice that some functions are not implemented in the 8chan API. These functions will raise an AttributeError when used.

License

           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
                   Version 2, December 2004

Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>

Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.

           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

 0. You just DO WHAT THE FUCK YOU WANT TO.