1. Paul Tan
  2. pypixiv

Commits

Paul Tan  committed 954f7c3

Added README.
Changed screen scraping to web scraping.

  • Participants
  • Parent commits 8cf376f
  • Branches default

Comments (0)

Files changed (2)

File README.rst

View file
+=======
+pypixiv
+=======
+
+pypixiv is a Python 3 API for Pixiv. 
+It aims to be a simple, easy to use,
+and lightweight alternative to other libraries,
+and to be specially suited for interactive python use
+such as through ipython.
+
+Currently a work in progress.
+
+Usage
+======
+(Placeholder names are used instead of actual values until I get a valid manga
+and illustration uploaded)
+
+First, create a `Pixiv` context::
+
+    >>> import pixiv
+    >>> context = pixiv.Pixiv("USERNAME", "PASSWORD")
+
+`Pixiv.get_url(url)` returns one of `Illust` or `Manga` based
+on the URL::
+
+    >>> x = context.get_url("MANGA OR ILLUST URL")
+    >>> x
+    Illust(Pixiv("USERNAME"), ILLUST_ID)
+
+Call `Pixiv.download(x)` to download a `Illust` or `Manga`::
+
+    >>> context.download(x)
+    ["FILENAME 1", "FILENAME 2", ...]
+
+And finally, logout::
+
+    >>> context.logout()
+
+Installation
+==============
+
+Installation uses `distutils`::
+
+    python3 setup.py build install
+
+Dependencies
+==============
+
+* Python **3**
+* BeautifulSoup_ 
+* requests_
+
+.. _BeautifulSoup: http://www.crummy.com/software/BeautifulSoup/
+.. _requests: https://github.com/kennethreitz/requests
+
+License
+=========
+ISC
+
+Alternative Libraries
+========================
+
+* PixivUtil2_
+
+.. _PixivUtil2: https://github.com/Nandaka/PixivUtil2
+

File pixiv.py

View file
 """
-API for Pixiv via screen scraping
+API for Pixiv via web scraping
 
 Usage
 ======