Use pip-compile to pin dependencies

Author: ckoehn

Makefile

@@ -1,24 +1,35 @@
+ENV_BASE=~/envs
+ENV=${ENV_BASE}/sqlalchemy-cockroachdb
+TOX=${ENV}/bin/tox
+
 .PHONY: all
 all: test lint
 
+.PHONY: bootstrap
+bootstrap:
+	@mkdir -p ${ENV}
+	virtualenv ${ENV}
+	${ENV}/bin/pip install -r dev-requirements.txt
+
+.PHONY: clean-bootstrap-env
+clean-bootstrap-env:
+	rm -rf ${ENV}
+
 .PHONY: test
 test:
-	tox
+	${TOX} -e py39
 
 .PHONY: lint
 lint:
-	tox -e lint
+	${TOX} -e lint
 
-# Update the requirements files (but does not install the updates; use
-# bootstrap.sh for that)
 .PHONY: update-requirements
 update-requirements:
-	./update-requirements.sh dev-requirements.txt
-	./update-requirements.sh test-requirements.txt
+	${TOX} -e pip-compile
 
 .PHONY: build
 build: clean
-	python setup.py sdist
+	${ENV}/bin/python setup.py sdist
 
 .PHONY: clean
 clean:

README.testing.md

@@ -28,9 +28,11 @@ Install them with
 
 Then, to run a complete test simply invoke
 
-    pytest
+    make test
 
-at a command prompt in your virtual environment.
+at a command prompt after you bootstrapped your environment with 
+
+    make bootstrap
 
 To run just the SQLAlchemy test suite, use
 

bootstrap.sh

@@ -0,0 +1,10 @@
+# Packages used by the Makefile
+#
+# To add/update dependencies, update dev-requirements.in (not the
+# generated dev-requirements.txt), run make update-requirements,
+# then make bootstrap.
+
+tox
+
+# Twine is used in the release process to upload the package.
+twine

dev-requirements.in

@@ -1,48 +1,84 @@
-# Packages used by the Makefile and other scripts.
-#
-# To add/update dependencies, update dev-requirements.txt.in (not the
-# generated dev-requirements.txt), run make update-requirements,
-# then re-run bootstrap.sh.
-
-flake8==3.9.2
-tox==3.23.1
-# Twine is used in the release process to upload the package.
-twine==3.4.1
-## The following requirements were added by pip freeze:
 appdirs==1.4.4
+    # via virtualenv
 bleach==3.3.0
+    # via readme-renderer
 certifi==2021.5.30
+    # via requests
 cffi==1.14.5
+    # via cryptography
 chardet==4.0.0
+    # via requests
 colorama==0.4.4
+    # via twine
 cryptography==3.4.7
+    # via secretstorage
 distlib==0.3.2
+    # via virtualenv
 docutils==0.17.1
+    # via readme-renderer
 filelock==3.0.12
+    # via
+    #   tox
+    #   virtualenv
 idna==2.10
-importlib-metadata==4.4.0
+    # via requests
+importlib-metadata==4.5.0
+    # via
+    #   keyring
+    #   twine
 jeepney==0.6.0
+    # via
+    #   keyring
+    #   secretstorage
 keyring==23.0.1
-mccabe==0.6.1
+    # via twine
 packaging==20.9
+    # via
+    #   bleach
+    #   tox
 pkginfo==1.7.0
+    # via twine
 pluggy==0.13.1
+    # via tox
 py==1.10.0
-pycodestyle==2.7.0
+    # via tox
 pycparser==2.20
-pyflakes==2.3.1
-Pygments==2.9.0
+    # via cffi
+pygments==2.9.0
+    # via readme-renderer
 pyparsing==2.4.7
+    # via packaging
 readme-renderer==29.0
-requests==2.25.1
+    # via twine
 requests-toolbelt==0.9.1
+    # via twine
+requests==2.25.1
+    # via
+    #   requests-toolbelt
+    #   twine
 rfc3986==1.5.0
-SecretStorage==3.3.1
+    # via twine
+secretstorage==3.3.1
+    # via keyring
 six==1.16.0
+    # via
+    #   bleach
+    #   readme-renderer
+    #   tox
+    #   virtualenv
 toml==0.10.2
-tqdm==4.61.0
-typing-extensions==3.10.0.0
+    # via tox
+tox==3.23.1
+    # via -r dev-requirements.in
+tqdm==4.61.1
+    # via twine
+twine==3.4.1
+    # via -r dev-requirements.in
 urllib3==1.26.5
+    # via requests
 virtualenv==20.4.7
+    # via tox
 webencodings==0.5.1
+    # via bleach
 zipp==3.4.1
+    # via importlib-metadata

dev-requirements.txt

@@ -0,0 +1,14 @@
+# Packages used when running tests. Installed by tox into multiple
+# virtualenvs.
+#
+# To add/update dependencies, update test-requirements.in (not the
+# generated test-requirements.txt) and run make update-requirements
+
+# Remove this once alembic 1.7 has been released
+git+https://github.com/sqlalchemy/alembic
+futures
+mock
+more-itertools
+psycopg2
+pytest
+sqlalchemy

dev-requirements.txt.in

@@ -1,30 +1,36 @@
-# Packages used when running tests. Installed by tox into multiple
-# virtualenvs.
-#
-# To add/update dependencies, update test-requirements.txt.in (not the
-# generated test-requirements.txt) and run make update-requirements
-
-SQLAlchemy==1.4.17
-# temporary tweak required until Alembic 1.7 is released:
 git+https://github.com/sqlalchemy/alembic
-more-itertools==8.8.0
-mock==4.0.3
-pytest==6.2.4
-futures==3.1.1
-psycopg2==2.8.6
-## The following requirements were added by pip freeze:
+    # via -r test-requirements.in
 attrs==21.2.0
+    # via pytest
+futures==3.1.1
+    # via -r test-requirements.in
 greenlet==1.1.0
-importlib-metadata==4.4.0
+    # via sqlalchemy
 iniconfig==1.1.1
+    # via pytest
+mako==1.1.4
+    # via alembic
+markupsafe==2.0.1
+    # via mako
+mock==4.0.3
+    # via -r test-requirements.in
+more-itertools==8.8.0
+    # via -r test-requirements.in
 packaging==20.9
+    # via pytest
 pluggy==0.13.1
+    # via pytest
+psycopg2==2.9.1
+    # via -r test-requirements.in
 py==1.10.0
+    # via pytest
 pyparsing==2.4.7
+    # via packaging
+pytest==6.2.4
+    # via -r test-requirements.in
+sqlalchemy==1.4.18
+    # via
+    #   -r test-requirements.in
+    #   alembic
 toml==0.10.2
-typing-extensions==3.10.0.0
-zipp==3.4.1
-Mako
-python-editor>=0.3
-python-dateutil
-six
+    # via pytest

test-requirements.in

@@ -18,3 +18,11 @@ deps =
   flake8==3.9.2
 commands =
   flake8 sqlalchemy_cockroachdb test
+
+[testenv:pip-compile]
+skip_install = True
+deps =
+    pip-tools==6.1.0
+commands =
+    pip-compile --upgrade --no-emit-index-url --no-header dev-requirements.in
+    pip-compile --upgrade --no-emit-index-url --no-header test-requirements.in