Skip to content

Latest commit

 

History

History
112 lines (78 loc) · 2.51 KB

README.md

File metadata and controls

112 lines (78 loc) · 2.51 KB
Raw

rule34py

GPL-3.0

Python api wrapper for rule34.xxx.

Getting Started

Install it using pip

pip install rule34py

Building it from Source

git clone https://github.com/b3yc0d3/rule34Py.git
cd rule34Py
python3 -m build

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(28)

# get a random post (in this case with tag(s))
random = r34Py.random_post(["neko"])

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

pip install -e .

Running the Test Suite

This project is tested by an organic pytest suite, stored under the :tests/ directory.

See the tests/README.md file for instructions on how to run the test suite.

Committing your Changes

  • Branch name should be prefixed with
    • fix- when fixing an bug/error
    • feat- when a feature got added
    • chore- 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.