RTD, version fix

Author: AivanF

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you want to use
+# The default way to use env vars in RTD
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt
+   - method: pip
+     path: .
+     extra_requirements:
+       - docs

.readthedocs.yaml

@@ -78,8 +78,7 @@ dev: clean ## install development dependencies
 	pre-commit install
 
 dist: clean ## builds source and wheel package
-	python setup.py sdist
-	python setup.py bdist_wheel
+	python -m build
 	ls -l dist
 
 release: dist ## package and upload a release

Makefile

@@ -148,11 +148,6 @@ Database views offer numerous advantages:
 
 This library makes it easy to leverage these benefits within your SQLAlchemy applications.
 
-## Documentation
-
-For complete documentation, examples, and API reference, visit:
-[https://github.com/AivanF/SQLAlchemy-ViewORM/docs](https://github.com/AivanF/SQLAlchemy-ViewORM/docs)
-
 ## Project Status
 
 This project is in passive development. We welcome contributions, bug reports, and feature requests, especially with suggested solutions. See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute.
@@ -173,7 +168,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## Documentation
 
-Full documentation is available in the [docs](https://github.com/AivanF/SQLAlchemy-ViewORM/tree/main/docs) directory.
+Full documentation is available on the [ReadTheDocs](https://sqlalchemy-vieworm.readthedocs.io/en/latest/), and its sources located in the [docs](https://github.com/AivanF/SQLAlchemy-ViewORM/tree/main/docs) directory.
 
 ## Examples
 

README.md

@@ -0,0 +1,3 @@
+# Documentation build requirements
+sphinx>=7.0.0
+sphinx_rtd_theme>=1.3.0

docs/requirements.txt

@@ -14,7 +14,7 @@
 project = "SQLAlchemy-ViewORM"
 copyright = "2025, AivanF."
 author = "AivanF."
-release = "0.1.0"
+release = "0.1.1"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/conf.py

@@ -220,11 +220,13 @@ More Examples
 -------------
 
 1. `Flask server <https://github.com/AivanF/SQLAlchemy-ViewORM/blob/main/examples/flask_example.py>`_
-  - single-file server
+  - Products with aggregated stats by category
+  - Single-file server
   - Materialized View integrated into API
-  - refresh by request
+  - Refresh by request
 
 2. `FastAPI server <https://github.com/AivanF/SQLAlchemy-ViewORM/tree/main/examples/FastAPI-example>`_
-  - multiple-file server draft
+  - Game matches with a leaderboard view
+  - Multiple-file server draft
   - Materialized View + async DB proper setup
-  - refresh by a background job
+  - Refresh by a periodic background job

docs/source/usage.rst

@@ -1,6 +1,6 @@
 [project]
 name = "SQLAlchemy-ViewORM"
-version = "0.1.0"
+version = "0.1.1"
 description = "A flexible ORM extension for defining and managing views (including materialized ones) in SQLAlchemy"
 readme = "README.md"
 authors = [{ name = "AivanF.", email = "[email protected]" }]
@@ -23,7 +23,7 @@ dependencies = ["sqlalchemy>=2.0.0"]
 requires-python = ">=3.9"
 
 [project.urls]
-Documentation = "https://aivanf.github.io/SQLAlchemy-ViewORM"
+Documentation = "https://sqlalchemy-vieworm.readthedocs.io/"
 Repository = "https://github.com/AivanF/SQLAlchemy-ViewORM"
 "Bug Tracker" = "https://github.com/AivanF/SQLAlchemy-ViewORM/issues"
 
@@ -38,29 +38,67 @@ dev = [
     "pre-commit>=3.0.0",
     "sphinx>=7.0.0",
     "sphinx_rtd_theme>=1.3.0",
+    "build>=0.10.0",
+    "twine>=4.0.0",
 ]
+docs = ["sphinx>=7.0.0", "sphinx_rtd_theme>=1.3.0"]
+examples = ["fastapi>=0.95.0", "uvicorn>=0.22.0"]
 
 [build-system]
-requires = ["setuptools>=42", "wheel"]
+requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["sqlalchemy_view_orm*"]
+
+[tool.setuptools.package-data]
+sqlalchemy_view_orm = ["py.typed"]
+
 [tool.black]
 line-length = 88
-target-version = ["py39", "py311", "py311", "py312"]
+target-version = ["py39", "py310", "py311", "py312"]
 include = '\.pyi?$'
+extend-exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.venv
+  | build
+  | dist
+)/
+'''
 
 [tool.isort]
 profile = "black"
 multi_line_output = 3
+line_length = 88
+known_first_party = ["sqlalchemy_view_orm"]
 
 [tool.mypy]
 python_version = "3.9"
 warn_return_any = true
 warn_unused_configs = true
 disallow_untyped_defs = true
 disallow_incomplete_defs = true
+show_error_codes = true
+strict = true
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 python_files = "test_*.py"
 pythonpath = ["."]
+addopts = "--strict-markers"
+markers = ["slow: marks tests as slow (deselect with '-m \"not slow\"')"]
+
+[tool.coverage.run]
+source = ["sqlalchemy_view_orm"]
+omit = ["*/tests/*", "*/test_*"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+]

pyproject.toml

@@ -1,14 +1,6 @@
-sqlalchemy>=2.0.0
+# Optional dependencies for examples
+# Install with: pip install -r requirements.txt
+# Or use: pip install "SQLAlchemy-ViewORM[examples]"
 
-# Development dependencies (not required for normal use)
-pytest>=7.0.0
-pytest-cov>=4.0.0
-black>=23.0.0
-isort>=5.0.0
-mypy>=1.0.0
-flake8>=6.0.0
-pre-commit>=3.0.0
-
-# For FastAPI example
 fastapi>=0.95.0
 uvicorn>=0.22.0