fundamental environment renovation - NO FUNCTIONAL CHANGES

Author: c0fec0de

.codespellignore

@@ -0,0 +1,2 @@
+udo
+anchestors

.github/workflows/main.yml

@@ -8,10 +8,8 @@ jobs:
         os:
           - "ubuntu-latest"
           - "macos-latest"
-          - "windows-latest"
+          # - "windows-latest"
         python-version:
-          - "3.7"
-          - "3.8"
           - "3.9"
           - "3.10"
           - "3.11"
@@ -26,6 +24,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
           enable-cache: true
           cache-dependency-glob: "uv.lock"
+      - name: Install graphviz
+        run: sudo apt install -y graphviz || true
       - name: Run all
         run: make all
       - name: Upload coverage data to coveralls.io

.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+exclude: ^tests/refdata/.*
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.

CONTRIBUTING.md

@@ -12,6 +12,7 @@ Please install these tools:
 * [`make`](https://www.gnu.org/software/make/)
 * [`git`](https://git-scm.com/)
 * [Visual Studio Code](https://code.visualstudio.com/)
+* [`graphviz`](https://graphviz.org/)
 
 
 ### Editor
@@ -31,6 +32,8 @@ make all
 
 See `make help` for any further details.
 
+Please note that `tests/refdata` contains reference data from test runs.
+`make test2refdata` updates this directory.
 
 ## Project Structure
 
@@ -63,6 +66,8 @@ Next to that, there are some temporary files ignored by version control system.
     * 2.x.x can be merged to 3.x.x
 * `main`
     * 2.x.x can be merged to main
+
+
 ### Release
 
 ```bash

Makefile

@@ -31,19 +31,23 @@ test: .venv/.valid ## [ALL] Run Unittests via 'pytest' with {PYTEST_OPTIONS}
 	@echo  "See coverage report:\n\n    file://${PWD}/htmlcov/index.html\n"
 
 
+.PHONY: test2refdata
+test2refdata: .venv/.valid ## Run Unittests via 'pytest' with {PYTEST_OPTIONS} and update tests/refdata
+	rm -rf tests/refdata
+	touch .test2ref
+	${ENV} pytest -vv ${PYTEST_OPTIONS}
+	@echo  "See coverage report:\n\n    file://${PWD}/htmlcov/index.html\n"
+	rm .test2ref
+
+
 .PHONY: checktypes
 checktypes: .venv/.valid ## [ALL] Run Type-Checking via 'mypy'
-	${ENV} mypy .
+	${ENV} mypy src
 
 
 .PHONY: doc
 doc: .venv/.valid ## [ALL] Build Documentation via 'mkdocs'
-	${ENV} mkdocs build --strict
-
-
-.PHONY: doc-serve
-doc-serve: .venv/.valid ## Start Local Documentation Server via 'mkdocs'
-	${ENV} mkdocs serve --no-strict
+	${ENV} make html -C docs
 
 
 .PHONY: code

README.rst

@@ -10,9 +10,6 @@
 .. image:: https://coveralls.io/repos/github/c0fec0de/anytree/badge.svg
     :target: https://coveralls.io/github/c0fec0de/anytree
 
-.. image:: https://readthedocs.org/projects/anytree/badge/?version=stable
-    :target: https://anytree.readthedocs.io/en/stable
-
 .. image:: https://api.codeclimate.com/v1/badges/e6d325d6fd23a93aab20/maintainability
    :target: https://codeclimate.com/github/c0fec0de/anytree/maintainability
    :alt: Maintainability

conftest.py

@@ -5,11 +5,9 @@
 
 @pytest.fixture(autouse=True)
 def _docdir(request):
-
     # Trigger ONLY for the doctests.
     doctest_plugin = request.config.pluginmanager.getplugin("doctest")
     if isinstance(request.node, doctest_plugin.DoctestItem):
-
         # Get the fixture dynamically by its name.
         tmpdir = request.getfixturevalue("tmpdir")
 

docs/dotexport.rst

@@ -19,7 +19,7 @@ This tree::
 Can be rendered to a tree by :any:`RenderTreeGraph`::
 
     >>> from anytree.dotexport import RenderTreeGraph
-    >>> RenderTreeGraph(root).to_picture("tree.png")
+    >>> RenderTreeGraph(root).to_picture("tree.png")  # doctest: +SKIP
 
 .. image:: static/tree.png
 

docs/index.rst

@@ -17,25 +17,9 @@ Any Python Tree Data
 .. image:: https://readthedocs.org/projects/anytree/badge/?version=stable
     :target: https://anytree.readthedocs.io/en/stable/
 
-.. image:: https://api.codeclimate.com/v1/badges/e6d325d6fd23a93aab20/maintainability
-   :target: https://codeclimate.com/github/c0fec0de/anytree/maintainability
-   :alt: Maintainability
-
 .. image:: https://img.shields.io/pypi/pyversions/anytree.svg
    :target: https://pypi.python.org/pypi/anytree
 
-.. image:: https://img.shields.io/badge/code%20style-pep8-brightgreen.svg
-   :target: https://www.python.org/dev/peps/pep-0008/
-
-.. image:: https://img.shields.io/badge/code%20style-pep257-brightgreen.svg
-   :target: https://www.python.org/dev/peps/pep-0257/
-
-.. image:: https://img.shields.io/badge/linter-pylint-%231674b1?style=flat
-   :target: https://www.pylint.org/
-
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-   :target: https://github.com/psf/black
-
 .. image:: https://img.shields.io/github/contributors/c0fec0de/anytree.svg
    :target: https://github.com/c0fec0de/anytree/graphs/contributors/
 
@@ -135,7 +119,7 @@ For details see :any:`Node` and :any:`RenderTree`.
 
 >>> from anytree.exporter import UniqueDotExporter
 >>> # graphviz needs to be installed for the next line!
->>> UniqueDotExporter(udo).to_picture("udo.png")
+>>> UniqueDotExporter(udo).to_picture("udo.png") # doctest: +SKIP
 
 .. image:: static/udo.png
 
@@ -144,7 +128,7 @@ The :any:`UniqueDotExporter` can be started at any node and has various formatti
 >>> UniqueDotExporter(dan,
 ...                   nodeattrfunc=lambda node: "fixedsize=true, width=1, height=1, shape=diamond",
 ...                   edgeattrfunc=lambda parent, child: "style=bold"
-... ).to_picture("dan.png")
+... ).to_picture("dan.png") # doctest: +SKIP
 
 .. image:: static/dan.png
 
@@ -204,7 +188,7 @@ Node('/Mary')
 
 **Extending any python class to become a tree node**
 
-The enitre tree magic is encapsulated by :any:`NodeMixin`,
+The entire tree magic is encapsulated by :any:`NodeMixin`,
 add it as base class and the class becomes a tree node:
 
 >>> from anytree import NodeMixin, RenderTree

docs/tricks/consistencychecks.rst

@@ -10,4 +10,3 @@ In case of any concerns about the internal data consistency or just for safety,
 
 >>> import anytree
 >>> anytree.config.ASSERTIONS = True
-

docs/tricks/readonly.rst

@@ -136,4 +136,3 @@ a
 │   └── a1a
 └── a2
     └── a0
-

docs/tricks/weightededges.rst

@@ -42,4 +42,3 @@ a (0)
 ... ).to_picture("weight.png")  # doctest: +SKIP
 
 .. image:: ../static/weight.png
-

docs/tricks/yaml.rst

@@ -98,4 +98,3 @@ AnyNode(a='root')
 .. _YAML: https://en.wikipedia.org/wiki/YAML
 
 .. _PYYAML: http://pyyaml.org/wiki/PyYAMLDocumentation
-