py8chan


Namepy8chan JSON
Version 0.2.2 PyPI version JSON
download
home_pagehttp://github.com/bibanon/py8chan
SummaryPython 8chan/vichan API Wrapper. Based on BASC-py4chan by the Bbiliotheca Anonoma
upload_time2024-12-15 16:37:06
maintainerNone
docs_urlNone
authorAntonizoon
requires_pythonNone
licenseDO 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.
keywords 8chan api vichan
VCS
bugtrack_url
requirements requests sphinxcontrib-napoleon
Travis-CI No Travis.
coveralls test coverage No coveralls.
            8chan/vichan Python Library
===========================

The Bibliotheca Anonoma’s **complete Python Wrapper for the 8chan 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 <http://py8chan.readthedocs.org/en/latest/index.html>`__

`Github Repository <https://github.com/bibanon/py8chan>`__

You can install this library `straight from
PyPi <https://pypi.python.org/pypi/py8chan>`__ with:

::

   pip install py8chan

Getting Help
------------

If you want help, or you have some trouble using this library,
put a issue on our `Github Issue Tracker <https://github.com/bibanon/py8chan>`__
and we’ll respond as soon as we can!

--------------

Usage
-----

.. code:: python

   import py8chan
   board = py8chan.Board('v')
   thread = board.get_thread(423491034)

   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 <https://github.com/bibanon/BASC-py4chan>`__, but has some
slight but major differences. See the py8chan documentation for more
info.

`py8chan
Documentation <http://py8chan.readthedocs.org/en/latest/index.html>`__

`The official 8chan Swagger API documentation can be found
here. <https://gitlab.com/N3X15/8chan-API/blob/master/definitions>`__

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.

            

Raw data

            {
    "_id": null,
    "home_page": "http://github.com/bibanon/py8chan",
    "name": "py8chan",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "8chan api vichan",
    "author": "Antonizoon",
    "author_email": "antonizoon@bibanon.org",
    "download_url": "https://files.pythonhosted.org/packages/1e/e7/0e6994abfabd0141ae122f95340a9d16274400f00efe8890facc2ccf164e/py8chan-0.2.2.tar.gz",
    "platform": null,
    "description": "8chan/vichan Python Library\n===========================\n\nThe Bibliotheca Anonoma\u2019s **complete Python Wrapper for the 8chan API.**\nUses requests, respects if-modified-since headers on updating threads.\nCaches thread objects. Fun stuff.\n\nAn absolute must if you want to interface with or scrape from 8chan or\nother vichan-based imageboards/textboards, using a Python script.\n\n`Hosted\nDocumentation <http://py8chan.readthedocs.org/en/latest/index.html>`__\n\n`Github Repository <https://github.com/bibanon/py8chan>`__\n\nYou can install this library `straight from\nPyPi <https://pypi.python.org/pypi/py8chan>`__ with:\n\n::\n\n   pip install py8chan\n\nGetting Help\n------------\n\nIf you want help, or you have some trouble using this library,\nput a issue on our `Github Issue Tracker <https://github.com/bibanon/py8chan>`__\nand we\u2019ll respond as soon as we can!\n\n--------------\n\nUsage\n-----\n\n.. code:: python\n\n   import py8chan\n   board = py8chan.Board('v')\n   thread = board.get_thread(423491034)\n\n   print(thread)\n\n   # supports displaying extra files in one post as well!\n   for file in thread.file_objects():\n       print(file.file_url)\n       \n   # In a while...\n   print(\"I fetched\", thread.update(), \"new replies.\")\n\nDocumentation\n-------------\n\nThis library mostly extends the classes of\n`BASC-py4chan <https://github.com/bibanon/BASC-py4chan>`__, but has some\nslight but major differences. See the py8chan documentation for more\ninfo.\n\n`py8chan\nDocumentation <http://py8chan.readthedocs.org/en/latest/index.html>`__\n\n`The official 8chan Swagger API documentation can be found\nhere. <https://gitlab.com/N3X15/8chan-API/blob/master/definitions>`__\n\nLicense\n-------\n\n::\n\n               DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE\n                       Version 2, December 2004\n\n    Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>\n\n    Everyone is permitted to copy and distribute verbatim or modified\n    copies of this license document, and changing it is allowed as long\n    as the name is changed.\n\n               DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE\n      TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION\n\n     0. You just DO WHAT THE FUCK YOU WANT TO.\n",
    "bugtrack_url": null,
    "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.  ",
    "summary": "Python 8chan/vichan API Wrapper. Based on BASC-py4chan by the Bbiliotheca Anonoma",
    "version": "0.2.2",
    "project_urls": {
        "Homepage": "http://github.com/bibanon/py8chan"
    },
    "split_keywords": [
        "8chan",
        "api",
        "vichan"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8f1b6326f080e72161196e05e0b703d1793a2d34f2bef43aba29ea523d6de2a5",
                "md5": "0f1948a67b61d8504959c02429ace730",
                "sha256": "45716b49b0d015ce646016d88bc89e2e2ac8fe9e78e0539fea4cc7df40c86c5b"
            },
            "downloads": -1,
            "filename": "py8chan-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0f1948a67b61d8504959c02429ace730",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 14166,
            "upload_time": "2024-12-15T16:37:04",
            "upload_time_iso_8601": "2024-12-15T16:37:04.966860Z",
            "url": "https://files.pythonhosted.org/packages/8f/1b/6326f080e72161196e05e0b703d1793a2d34f2bef43aba29ea523d6de2a5/py8chan-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1ee70e6994abfabd0141ae122f95340a9d16274400f00efe8890facc2ccf164e",
                "md5": "81de7b4ddf90c9d4941846bb16a3e0b4",
                "sha256": "76a58c66dd5879ccfecc1f74e0e4df7e140393f2aea4d7e0874c8a9b1f4f1420"
            },
            "downloads": -1,
            "filename": "py8chan-0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "81de7b4ddf90c9d4941846bb16a3e0b4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 13067,
            "upload_time": "2024-12-15T16:37:06",
            "upload_time_iso_8601": "2024-12-15T16:37:06.363738Z",
            "url": "https://files.pythonhosted.org/packages/1e/e7/0e6994abfabd0141ae122f95340a9d16274400f00efe8890facc2ccf164e/py8chan-0.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-15 16:37:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bibanon",
    "github_project": "py8chan",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "sphinxcontrib-napoleon",
            "specs": []
        }
    ],
    "lcname": "py8chan"
}
        
Elapsed time: 0.52744s