Documentation for running tox tests misses poetry note

[ajnelson-nist]

I hit an unexpected CI failure in only Python3.11 on a PR this morning. I tried following the directions in this box in a totally fresh clone of rdflib under /tmp, to locally reproduce the issue:

https://rdflib.readthedocs.io/en/latest/developers.html#using-tox

(An aside - The first command tox -e appears to have changed its behavior since the documentation was written. That flag now requires a value.)

It seems there is an unstated dependency on poetry, because when I tried running tox -e py311, I got an unexplained failure when poetry attempted to grab a lock. The failure seems to be that poetry wasn't installed.

Here were my commands:

cd /tmp
git clone https://github.com/RDFLib/rdflib.git
cd rdflib
python3.11 -m venv venv
source venv/bin/activate
pip install --upgrade pip setuptools wheel
pip install tox
tox -e py311

The last lines of the test output were:

py311: commands_pre[1]> poetry lock --check
py311: exit 2 (0.00 seconds) /private/tmp/rdflib> poetry lock --check
.pkg: _exit> python /private/tmp/rdflib/venv/lib/python3.11/site-packages/pyproject_api/_backend.py True poetry.core.masonry.api
  py311: FAIL code 2 (20.18=setup[19.44]+cmd[0.74,0.00] seconds)
  evaluation failed :( (20.26 seconds)

Should that documentation box be updated to read pip install tox poetry; or is there some other configuration file that was supposed to have taken care of this automatically?

[aucampia]

https://rdflib.readthedocs.io/en/latest/developers.html#using-tox

For some reason, https://rdflib.readthedocs.io/en/latest is not actually the latest (i.e. latest commit on the main branch). I just changed some readthedocs settings and initiated a manual build, and I will keep an eye on it to see if it updates latest automatically now.

Should that documentation box be updated to read pip install tox poetry; or is there some other configuration file that was supposed to have taken care of this automatically?

The develops guide does say:

rdflib/docs/developers.rst

Line 17 in 0593c75

* RDFLib uses `Poetry <https://python-poetry.org/docs/master/>`_ for dependency management and packaging.

But maybe that should be changed to this:

* RDFLib uses `Poetry <https://python-poetry.org/docs/master/>`_ for dependency management and packaging and you will need to have it installed on your system to contribute to RDFLib. Follow the `Poetry installation instructions <https://python-poetry.org/docs/#installation>`_ to get it.

It would possibly also be good to note poetry is required somewhere in the "Using tox" section, but I think it is not advised to install poetry outside a dedicated venv, and it would be best to rather refer people to the Poetry installation instructions.

[aucampia]

For some reason, https://rdflib.readthedocs.io/en/latest is not actually the latest (i.e. latest commit on the main branch). I just changed some readthedocs settings and initiated a manual build, and I will keep an eye on it to see if it updates latest automatically now.

This seems to be better now, it rebuilt automatically after merging the last PR.