Brining develop back up to date

.github/actions/build-project/action.yml

@@ -0,0 +1,21 @@
+name: Build the project
+description: Installs project dependencies and builds the project
+
+inputs:
+  latest_python:
+    default: false
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ">=3.5"
+        check-latest: ${{ inputs.latest_python }}
+
+    - name: Build documentation
+      shell: bash
+      run: |
+        python3 -m pip install .[docs]
+        make html

.github/workflows/gh-pages.yml

@@ -0,0 +1,28 @@
+name: Publish GH Pages
+
+on:
+    push:
+      branches:
+        - master
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Build the project
+        uses: ./.github/actions/build-project
+
+      - name: Deploy to Github Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build/html

.github/workflows/pr-checks.yml

@@ -0,0 +1,44 @@
+name: PR Checks
+
+on:
+  pull_request:
+    branches:
+      - "**"
+
+jobs:
+  build-linux:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Build the project
+        uses: ./.github/actions/build-project
+        with:
+          latest_python: true  # always use the latest python in PR checks
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-${{ github.run_id }}-${{ github.run_number }}
+          path: ./build
+          retention-days: 14
+
+      - name: Lint the project
+        shell: bash
+        run: |
+          python -m pip install .[dev]
+          make lint
+
+
+  build-windows:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Build the project
+        uses: ./.github/actions/build-project
+        with:
+          latest_python: true  # always use the latest python in PR checks

Makefile

@@ -0,0 +1,69 @@
+
+.DEFAULT_GOAL = all
+
+PROJECT = rule34py
+VERSION = $(shell git describe --tags)
+
+PYTHON3 ?= python3
+PYTHON_BUILD = $(PYTHON3) -m build
+RUFF = $(PYTHON3) -m ruff
+SPHINX_BUILD = $(PYTHON3) -m sphinx
+PYTEST = $(PYTHON3) -m pytest
+
+builddir ?= build
+srcdir = rule34Py
+
+# Installation Directories
+prefix ?= /usr/local
+
+docdir ?= $(prefix)/share/doc/$(project)
+htmldir ?= $(docdir)/html
+
+
+# REAL TARGETS #
+################
+
+
+# PHONY TARGETS #
+#################
+
+all : html
+	$(PYTHON3) -m build --wheel --outdir $(builddir) --verbose
+.PHONY : all
+
+
+check :
+	PYTHONPATH=$(srcdir)/.. $(PYTEST) tests/unit/
+.PHONY : check
+
+
+clean : mostlyclean
+	find ./ -depth -path '**/.pytest_cache*' -print -delete
+	find ./ -depth -path '**/__pycache__*' -print -delete
+	$(RUFF) clean
+.PHONY : clean
+
+
+dist :
+	$(PYTHON_BUILD) --sdist --outdir $(builddir)
+.PHONY : dist
+
+
+distclean : clean
+.PHONY : distclean
+
+
+html :
+	$(SPHINX_BUILD) --builder html docs $(builddir)/html
+.PHONY : html
+
+
+lint :
+	$(RUFF) check $(srcdir)
+.PHONY : lint
+
+
+mostlyclean :
+	rm -rf $(builddir)
+	find ./ -depth -path '**/rule34Py.egg-info*' -print -delete
+.PHONY : mostlyclean

NOTICE.md

@@ -1,6 +1,8 @@
+# NOTICE
+
 The following third-party software is used in this project:
 
-# Responses
+## Responses
 * Licensed under the Apache License, Version 2.0
 * Copyright (c) David Cramer
 

README.md

@@ -4,31 +4,25 @@
 
 ![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/).
+Python API wrapper for [rule34.xxx](https://rule34.xxx/).
 </div>
 
-## Getting Started
 
-#### Install it using pip
-```
-pip install rule34py
-```
+## Installation
 
-#### Building it from Source
-```
-git clone https://github.com/b3yc0d3/rule34Py.git
-cd rule34Py
-python3 -m build
+[rule34Py](https://pypi.org/project/rule34Py/) is available directly from the Python Package Index and can be installed via `pip`.
+
+```bash
+pip install rule34Py
 ```
 
-## Documentation
-You can find the documentation [here](https://github.com/b3yc0d3/rule34Py/tree/master/docs).
+Or you can build it from source using this project.
+See the [Developer Guide](https://b3yc0d3.github.io/rule34Py/dev/developer-guide.html) for more information.
+
 
-> [!NOTE]
-> The documentation might move in the future.
+## Quickstart
 
-## Code Snippet
-```py
+```python
 from rule34Py import rule34Py
 r34Py = rule34Py()
 
@@ -54,62 +48,9 @@ random = r34Py.random_post()
 random_id = r34Py.random_post_id()
 ```
 
-## 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`](./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
+## Documentation
 
-Here goes the description
-```
+This project has extensive [documentation](https://b3yc0d3.github.io/rule34Py/), hosted on the upstream Github Pages. It includes additional **Tutorials**, **User Guides**, **API Documentation**, and more.
 
-The title shall not be longer then 50 characters.
-**Select the `develop` branch for pull requests.**
+See the [Contributing Guide](https://b3yc0d3.github.io/rule34Py/dev/contributing.html) for information about how to contribute to this project and file bugs.