API wraper for rule34.xxx
Project description
Getting Started
Install it using pip
pip install rule34py
Install it from Source
git clone https://github.com/b3yc0d3/rule34Py.git
cd rule34Py
python setup.py sdist
pip install -e .
Documentation
You can find the documentation here.
[!NOTE] The documentation might move in the future.
Code Snippet
from rule34Py import rule34Py
r34Py = rule34Py()
# get comments of an post
r34Py.get_comments(4153825)
# get post by its id
r34Py.get_post(4153825)
# get top 100 icame
r34Py.icame()
# search for posts by tag(s)
r34Py.search(["neko"], page_id=2, limit=50)
# get pool by id
r34Py.get_pool(17509)
# get a random post (in this case with tag(s))
random = r34Py.random_post(["neko"])
# get general site stats
r34Py.stats.top_taggers()
r34Py.stats.top_commenters()
r34Py.stats.top_forum_posters()
r34Py.stats.top_image_posters()
r34Py.stats.top_note_editors()
r34Py.stats.top_favorites()
Development
Follow these steps to setup everything needed to develop on rule34Py.
Currently this setup guide only shows how it is done on unix-like systems.
Clone This Repository
git clone https://github.com/b3yc0d3/rule34Py.git
cd rule34Py
git checkout develop
Setting Up Virtual Python Environment
python -m venv venv
source venv/bin/activate
To deactivate the virtual environment type the following in your terminal
deactivate
Install and Build rule34Py in the Virtual Environment
python3 -m build -s -w -n
pip install -e .
Committing your Changes
- Branch name should be prefixed with
fix-
when fixing an bug/errorfeat-
when a feature got addedchore-
everything else that doesn't fall in the above categories
- The title must be descriptive, what your pull request changes/does.
- Write a breve description of what the pull request does/solves in the commit.
- If your pull request fixes an issue, please mention that issue in the commit title.
Example structure of a commit message
here goes the title of the commit
Here goes the description
The title shall not be longer then 50 characters.
Select the develop
branch for pull requests.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
rule34Py-1.4.11.tar.gz
(24.9 kB
view hashes)
Built Distribution
rule34Py-1.4.11-py3-none-any.whl
(29.8 kB
view hashes)
Close
Hashes for rule34Py-1.4.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1e8c84afb85a9d7b372ddc33f2ce47aaf79264ce583df353e63419624ae6ca5 |
|
MD5 | 93701150e7b491f548a776ffc898c586 |
|
BLAKE2b-256 | 9b0e32035a36db106a03e81c2052afa2f8f0206309adf73d8db5230e77e56b78 |