]> git.ipfire.org Git - thirdparty/psycopg.git/commitdiff
docs: document how to unbreak editable mode in the readme
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>
Wed, 26 Oct 2022 01:07:28 +0000 (03:07 +0200)
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>
Thu, 27 Oct 2022 00:09:06 +0000 (02:09 +0200)
README.rst

index f71a53d2b154c15fdcaa910c3abaee653cd754a9..040c9c158cb1ef69f9c2a31435e6cca642ca0fef 100644 (file)
@@ -58,11 +58,16 @@ requirements::
     python -m venv .venv
     source .venv/bin/activate
     pip install -e "./psycopg[dev,test]"    # for the base Python package
-    pip install -e ./psycopg_c              # for the C extension module
     pip install -e ./psycopg_pool           # for the connection pool
+    pip install ./psycopg_c                 # for the C speedup module
 
 .. __: https://pip.pypa.io/en/stable/reference/pip_install/#install-editable
 
+Please add ``--config-settings editable_mode=strict`` to the ``pip install
+-e`` above if you experience `editable mode broken`__.
+
+.. __: https://github.com/pypa/setuptools/issues/3557?
+
 Now hack away! You can use tox to validate the code::
 
     pip install tox