b3yc0d3 · b3yc0d3 · Aug 30, 2025 · Jun 14, 2025 · Jun 14, 2025 · Jun 15, 2025
diff --git a/.github/actions/build-project/action.yml b/.github/actions/build-project/action.yml
@@ -17,11 +17,9 @@ runs:
     - name: Install host python dependencies
       shell: bash
       run: |
-        python -m pip install --upgrade setuptools build
-        python -m pip install . .[dev] .[docs] .[test]
-        pip freeze \
-          --exclude rule34Py \
-          >build/requirements.txt
+        pipx install poetry
+        poetry self update
+        poetry install
 
     - name: Build wheel and dist
       shell: bash

diff --git a/.github/workflows/ci-develop.yml b/.github/workflows/ci-develop.yml
@@ -32,5 +32,4 @@ jobs:
       - name: Run unit tests
         shell: bash
         run: |
-          python -m pip install .[test]
           make check
diff --git a/.github/workflows/pr-checks.yml b/.github/workflows/pr-checks.yml
@@ -41,5 +41,7 @@ jobs:
       - name: Lint sources
         shell: bash
         run: |
-          python -m pip install .[dev]
+          pipx install poetry
+          poetry self update
+          poetry install
           make lint
diff --git a/.gitignore b/.gitignore
@@ -1,163 +1,17 @@
-publish.sh
-debug*
-__pycache__
-setup.py
-LICENSE.txt
-stats.py
-rule34Py_old.py
-
-# Created by https://www.toptal.com/developers/gitignore/api/python
-# Edit at https://www.toptal.com/developers/gitignore?templates=python
-
 ### Python ###
 # Byte-compiled / optimized / DLL files
-__pycache__/
+**/__pycache__
 *.py[cod]
 *$py.class
 
-# C extensions
-*.so
-
 # Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-parts/
-sdist/
-var/
-wheels/
-pip-wheel-metadata/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
+/build
+**/*.egg-info
 
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
 
 # Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-pytestdebug.log
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-doc/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-.python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#poetry.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-# .env
-.env/
-.venv/
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-pythonenv*
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# operating system-related files
-# file properties cache/storage on macOS
-*.DS_Store
-# thumbnail cache on Windows
-Thumbs.db
-
-# profiling data
-.prof
-
-
-# End of https://www.toptal.com/developers/gitignore/api/python
+**/.pytest_cache
 
+# Ruff
 **/.ruff_cache
+dist/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,19 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [4.0.0] - 2025-08-31
+
+### Added
+ - Added a `rule34Py.autocomplete` method.
+ - Added `AutocompleteTag` class.
+ - Added parameter to `rule34Py.search` method for excluding ai generated content.
+ 	- Added unit test
+
+### Changed
+ - Updated API wrapper to support website’s new authentication system.
+ - The underlying website API now **requires authentication** (`api_key` and `user_id`) for all requests.
+ - Updated unit tests.
+
 ## [3.0.0] - 2025-06-09
 
 ### Added

diff --git a/Makefile b/Makefile
@@ -3,12 +3,14 @@ PROJECT = $(shell $(PYTHON3) scripts/read_pyproject.py project/name | tr 'A-Z' '
 VERSION = $(shell $(PYTHON3) scripts/read_pyproject.py project/version)
 
 # Binaries
-PYTHON3 ?= python3
-PYTEST = $(PYTHON3) -m pytest
-PYTHON_BUILD = $(PYTHON3) -m build
-RUFF = $(PYTHON3) -m ruff
-SPHINX = $(PYTHON3) -m sphinx
-TWINE = $(PYTHON3) -m twine
+POETRY ?= poetry $(POETRY_ARGS)
+POETRY_ARGS ?=
+PYTHON3 ?= $(POETRY) run python3
+
+PYTEST = $(POETRY) run pytest $(PYTEST_ARGS)
+PYTEST_ARGS ?=
+RUFF = $(POETRY) run ruff
+SPHINX_BUILD = $(POETRY) run sphinx-build
 
 # Source files
 builddir ?= build
@@ -38,25 +40,25 @@ htmldir ?= $(docdir)/html
 ################
 
 $(wheels) &: $(dist_files)
-	$(PYTHON_BUILD) --outdir $(builddir) --wheel
+	$(POETRY) build --output $(builddir) --format=wheel
 
 
 $(sdist) : $(dist_files)
-	$(PYTHON_BUILD) --outdir $(builddir) --sdist
+	$(POETRY) build --output $(builddir) --format=sdist
 
 
 # PHONY TARGETS #
 #################
 
 # Build all binary targets necessary for installation.
 # Does not build documentation or source distributions.
-all : $(wheels)
+all : $(wheels) $(sdist)
 .PHONY : all
 
 
 # Run pre-installation tests on the built artifacts.
 check : all
-	PYTHONPATH=$(builddir)/lib $(PYTEST) tests/unit/
+	PYTHONPATH=. $(PYTEST) tests/unit/
 .PHONY : check
 
 
@@ -75,19 +77,24 @@ dist : $(sdist)
 
 # Check and publish the python package index artifacts.
 publish : $(sdist) $(wheels)
-	$(TWINE) check $(^)
-	$(TWINE) upload $(^)
+	$(POETRY) publish --dist-dir=$(builddir)
 .PHONY : publish
 
 
 # Build the project's HTML documentation.
 html :
-	$(SPHINX) --builder html docs $(builddir)/html
+	$(SPHINX_BUILD) --builder html docs $(builddir)/html
 .PHONY : html
 
 
+linkcheck :
+	$(SPHINX_BUILD) --builder linkcheck docs $(builddir)/linkcheck
+.PHONY : linkcheck
+
+
 # Lint the project source for quality.
-lint :
+lint : linkcheck
+	$(POETRY) check --strict
 	$(RUFF) check $(srcdir)
 .PHONY : lint
 

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 # rule34py
 
-![GPL-3.0](https://img.shields.io/github/license/b3yc0d3/rule34Py) [![](https://img.shields.io/pypi/v/rule34Py)](https://pypi.org/project/rule34Py/) [![](https://img.shields.io/pypi/dm/rule34py?color=blue)](https://pypi.org/project/rule34Py/)
+![Build Status](https://img.shields.io/github/actions/workflow/status/b3yc0d3/rule34Py/cd-master.yml) ![GPL-3.0](https://img.shields.io/github/license/b3yc0d3/rule34Py) [![](https://img.shields.io/pypi/v/rule34Py)](https://pypi.org/project/rule34Py/) [![](https://img.shields.io/pypi/dm/rule34py?color=blue)](https://pypi.org/project/rule34Py/)
 
 Python API wrapper for [rule34.xxx](https://rule34.xxx/).
 </div>
@@ -24,28 +24,30 @@ See the [Developer Guide](https://b3yc0d3.github.io/rule34Py/dev/developer-guide
 
 ```python
 from rule34Py import rule34Py
-r34Py = rule34Py()
+client = rule34Py()
+client.api_key = "YOUR_API_KEY"
+client.user_id = "YOUR_USER_ID"
 
 # Get comments of an post.
-r34Py.get_comments(4153825)
+client.get_comments(4153825)
 
 # Get post by its id.
-r34Py.get_post(4153825)
+client.get_post(4153825)
 
 # Get top 100 icame.
-r34Py.icame()
+client.icame()
 
 # Search for posts by tag(s).
-r34Py.search(["neko"], page_id=2, limit=50)
+client.search(["neko"], page_id=2, limit=50)
 
 # Get pool by id.
-r34Py.get_pool(28)
+client.get_pool(28)
 
 # Get a random post.
-random = r34Py.random_post()
+random = client.random_post()
 
 # Get just a random post ID.
-random_id = r34Py.random_post_id()
+random_id = client.random_post_id()
 ```
 
 

diff --git a/docs/_static/api-credentials.png b/docs/_static/api-credentials.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -45,6 +45,7 @@
 
 # sphinx.ext.autodoc configuration #
 autodoc_default_options = {
+    "private-members": False
 }
 autodoc_typehints = "both"  # Show typehints in the signature and as content of the function or method
 
@@ -53,6 +54,13 @@
     "requests": ("https://requests.readthedocs.io/en/latest/", None),
 }
 
+## Sphinx linkcheck options
+linkcheck_ignore = [
+    r"https?://.*gnu.org(:\d+)?[/$]?.*",  # GNU.org is heavily rate limited
+    r"https?://localhost(:\d+)?[/$]?.*",  # Broken unless the dev is hosting a server.
+    r"https?://rule34.xxx(:\d+)?[/$]?.*",  # Interactive site will always 403
+]
+
 
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst
@@ -6,7 +6,7 @@ Thanks for taking an interest in contributing to the rule34Py project!
 
 * This project's **canonical upstream** is at https://github.com/b3yc0d3/rule34Py.
 * File **bugs**, **enhancement requests**, and other **issues** to the GH issue tracker at https://github.com/b3yc0d3/rule34Py/issues.
-* See the `Developer Guide <./developer-guide.html>`_ for information about how to **build** this project from source and run tests.
+* See the :doc:`Developer Guide <./developer-guide>` for information about how to **build** this project from source and run tests.
 
 
 Submitting Changes
@@ -18,7 +18,7 @@ Submitting Changes
 
     .. code-block:: bash
 
-        pip install .[dev]
+        poetry install  # Optional, if you have not done it previously.
         make lint
 
     Fix or respond to any findings in the linter.
@@ -27,7 +27,7 @@ Submitting Changes
 
     .. code-block:: bash
 
-        pip install .[test]
+        poetry install  # Optional, if you have not done it previously.
         make check
 
 #. Write a good commit message. If you are unsure of how, `this cbeams article <https://cbea.ms/git-commit/>`_ gives reasonable suggestions. Commit your changes.