pip install rule34py
git clone https://github.com/b3yc0d3/rule34Py.git
cd rule34Py
python setup.py sdist
pip install -e .
You can find the documentation here.
Note
The documentation might move in the future.
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()
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.
git clone https://github.com/b3yc0d3/rule34Py.git
cd rule34Py
git checkout develop
python -m venv venv
source venv/bin/activate
To deactivate the virtual environment type the following in your terminal
deactivate
python3 -m build -s -w -n
pip install -e .
- 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.