Document dependencies, and add pinned setup.cfg dependencies in requirements-dev.txt via pip-compile.

.gitignore

@@ -110,3 +110,4 @@ dmypy.json
 # End of https://www.gitignore.io/api/python
 
 /venv
+.venv/

README.rst

@@ -28,6 +28,26 @@ install ``gettext`` first, for example on Debian run::
 Contributing
 ============
 
-Start by creating a venv and installing `requirements-dev.in`.
+Start by creating a venv and ``pip install -r requirements-dev.txt`` in
+it.
 
-To run the tests, use `tox -p auto`.
+To run the tests, use ``tox -p auto``.
+
+To install ``powrap`` in the current venv run ``pip install -e .``.
+
+
+Dependencies
+------------
+
+We're using ``pip-tools`` to pin our dependencies, but in the
+``setup.cfg`` our dependencies are *not* pinned, the goal is to ensure
+``powrap`` can easily be installed along with other tools.
+
+Dependencies pinning is only done to have a reproducible development
+environment and corresponding env in the CI::
+
+  pip-compile setup.py  # generates requirements.txt
+  pip-compile requirements-dev.in  # generates requirements-dev.txt
+
+It's possible to upgrade pinned dependencies with the ``--upgrade``
+flag of ``pip-compile``.

requirements-dev.in

@@ -1,4 +1,4 @@
-black
+-r requirements.txt
 black
 flake8
 mypy

requirements-dev.txt

@@ -48,7 +48,7 @@ secretstorage==3.1.2      # via keyring
 six==1.15.0               # via astroid, bleach, cryptography, packaging, pip-tools, readme-renderer, tox, virtualenv
 toml==0.10.1              # via black, pylint, tox
 tox==3.15.2               # via -r requirements-dev.in
-tqdm==4.46.1              # via twine
+tqdm==4.50.1              # via -r requirements.txt, twine
 twine==3.1.1              # via -r requirements-dev.in
 typed-ast==1.4.1          # via black, mypy
 typing-extensions==3.7.4.2  # via mypy

requirements.txt

@@ -0,0 +1,7 @@
+#
+# This file is autogenerated by pip-compile
+# To update, run:
+#
+#    pip-compile setup.py
+#
+tqdm==4.50.1              # via powrap (setup.py)