From cd45259ea914de5ca68790cbcebc136e310d23a3 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc kop@karlpinc.com" Date: Fri, 20 Oct 2023 20:55:57 +0000 Subject: [PATCH] Tools for managing python3 virtual environments --- .gitignore | 2 + Makefile | 127 +++++++++++++++++++++++++++++++++ README | 6 ++ help.mk | 26 +++++++ reqs/pgadmin4_requirements.txt | 106 +++++++++++++++++++++++++++ 5 files changed, 267 insertions(+) create mode 100644 .gitignore create mode 100644 Makefile create mode 100644 README create mode 100644 help.mk create mode 100644 reqs/pgadmin4_requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3204349 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +# The generated requirements.txt.new files +reqs/*_requirements.txt.new diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..42b0ddb --- /dev/null +++ b/Makefile @@ -0,0 +1,127 @@ +# Copyright (C) 2023 The Meme Factory, Inc. www.karlpinc.com +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +# Karl O. Pinc + +# +# Variables +# + +# Those files that might change the rebuild results +GENERIC_DEPENDS := Makefile + +# The directory holding virtual environments +VENV_DIR := /srv/venvs +# The virtual enviornment being worked with +VENV_PATH := $(VENV_DIR)/$(TARGET_VENV) + +# The directory holding the requirements.txt files +REQ_DIR := reqs +# The path to the requirements.txt file of the venv +REQ_PATH := $(REQ_DIR)/$(TARGET_VENV)_requirements.txt + +# Make "help" be the default target +include help.mk + +## ######################################################################## +## PYTHON VIRTUAL ENVIRONMENTS +## +## Manage the system's python virtual environments, supporting functionality +## like exact re-creation of virtual environments on different hosts, +## easy upgrade and rollback of virtual environments, etc. +## +## Variables: +## +## TARGET_VENV +## Name of the virtual environment on which to operate. +## TARGET_PKG +## Name of the python package(s) on which to operate. More than +## one package can be specified. Separate the different packages with +## a space character. +## VENV_DIR +## Directory holding the python virtual environments. Defaults +## to: /srv/venvs +## +## To make a new virtual environment: +## Use the "init" target to make the venv. +## Use the venv's "pip" command to install the desired packages. +## Use the "new-requirements" target to create a file of requirements. +## Move reqs/$TARGET_VENV_requirements.txt.new to +## reqs/$TARGET_VENV_requirements.txt and commit the file. +## +## To upgrade a virtual environment: +## Use the "upgrade" target to upgrade the venv. +## Use the "new-requirements" target to create a file of requirements. +## Move reqs/$TARGET_VENV_requirements.txt.new to +## reqs/$TARGET_VENV_requirements.txt and commit the file. +## +## To rollback to a previous virtual environment: +## Checkout the version of the requirements.txt file to which you wish +## to rollback: git checkout $COMMIT reqs/$TARGET_VENV_requirements.txt +## Remove the virtual environment with the "destroy" target +## Create a new virtual environment with the "install" target +## Commit the old requirements.txt file. +## +## Targets: +## +## init Initialize a new virtual environment for TARGET_VENV +init: $(VENV_PATH) + +$(VENV_PATH): + python3 -m venv $(VENV_PATH) + python3 -m venv --upgrade-deps $(VENV_PATH) + +## install Install a new TARGET_VENV +.PHONY: install +install: init + $(VENV_PATH)/bin/pip install -r $(REQ_PATH) + +## report-old Report on outdated packages in TARGET_VENV +## CAUTION: Many packaged applications fix all of +## their library versions; newer library versions should +## _not_ be installed when they become available. +.PHONY: report-old +report-old: + $(VENV_PATH)/bin/pip list -o + +## upgrade Upgrade the TARGET_PKG in TARGET_VENV to the latest +## version +.PHONY: upgrade +upgrade: + $(VENV_PATH)/bin/pip install -U --upgrade-strategy eager $(TARGET_PKG) + +## new-requirements Produce a python package version requirement file +## able to reproduce the existing venv +## (Copy to reqs/$TARGET_VENV_requirements.txt to make +## effective.) +# The grep works-around a bug that's in Debian 11's venv code +.PHONY: new-requirements +new-requirements: $(REQ_PATH).new + +.PHONY: $(REQ_PATH).new +# The grep works-around a bug that's in Debian 11's venv code +$(REQ_PATH).new: + $(VENV_PATH)/bin/pip freeze \ + | grep -vF 'pkg_resources==0.0.0' \ + > $(REQ_PATH).new + +## destroy Remove TARGET_VENV +.PHONY: destroy +destroy: + rm -rf $(VENV_PATH) + +## +## The point of Python virtual environments is to be able to easily re-create +## them. So don't hesitate to destroy and re-create them. diff --git a/README b/README new file mode 100644 index 0000000..9c07dbd --- /dev/null +++ b/README @@ -0,0 +1,6 @@ +Type "make" in this directory for help. + +This software repository contains tools, mostly make based, that +assist in the management of the overall environment of the server +which hosts SokweDB. Its primary purpose is to manage python virtual +environments. diff --git a/help.mk b/help.mk new file mode 100644 index 0000000..bc89451 --- /dev/null +++ b/help.mk @@ -0,0 +1,26 @@ +# Generate help summary from Makefile content +# Copyright (C) 2019 The Meme Factory, Inc. www.karlpinc.com +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +# Use this by putting the following line into your Makefile: +# include help.mk +# +# Then, any lines in the makefiles that begin with "## ", or lines +# that contain only "##", are displayed as help text. This allows +# user-documentation to be placed next to relevant makefile targets +# and rules. + +help: + @grep -Eh '^##($$| )' $(MAKEFILE_LIST) | sed -E 's/^##($$| )//' diff --git a/reqs/pgadmin4_requirements.txt b/reqs/pgadmin4_requirements.txt new file mode 100644 index 0000000..5c09ed2 --- /dev/null +++ b/reqs/pgadmin4_requirements.txt @@ -0,0 +1,106 @@ +alembic==1.12.0 +Authlib==1.2.1 +azure-common==1.1.28 +azure-core==1.29.4 +azure-identity==1.13.0 +azure-mgmt-core==1.4.0 +azure-mgmt-rdbms==10.1.0 +azure-mgmt-resource==23.0.1 +azure-mgmt-subscription==3.1.1 +Babel==2.13.0 +bcrypt==4.0.1 +bidict==0.22.1 +blinker==1.6.3 +boto3==1.28.66 +botocore==1.31.66 +Brotli==1.1.0 +cachetools==5.3.1 +certifi==2023.7.22 +cffi==1.16.0 +charset-normalizer==3.3.0 +click==8.1.7 +cryptography==40.0.2 +dnspython==2.4.2 +email-validator==2.0.0.post2 +eventlet==0.33.3 +Flask==2.2.5 +flask-babel==3.1.0 +Flask-Compress==1.14 +Flask-Gravatar==0.5.0 +Flask-Login==0.6.2 +Flask-Mail==0.9.1 +Flask-Migrate==4.0.5 +Flask-Paranoid==0.3.0 +Flask-Principal==0.4.0 +Flask-Security-Too==5.1.2 +Flask-SocketIO==5.3.6 +Flask-SQLAlchemy==3.0.5 +Flask-WTF==1.1.1 +google-api-core==2.12.0 +google-api-python-client==2.104.0 +google-auth==2.23.3 +google-auth-httplib2==0.1.1 +google-auth-oauthlib==1.0.0 +googleapis-common-protos==1.61.0 +greenlet==1.1.2 +h11==0.14.0 +httpagentparser==1.9.5 +httplib2==0.22.0 +idna==3.4 +importlib-metadata==6.8.0 +isodate==0.6.1 +itsdangerous==2.1.2 +jaraco.classes==3.3.0 +jeepney==0.8.0 +Jinja2==3.1.2 +jmespath==1.0.1 +keyring==23.13.1 +ldap3==2.9.1 +Mako==1.2.4 +MarkupSafe==2.1.3 +more-itertools==10.1.0 +msal==1.24.1 +msal-extensions==1.0.0 +msrest==0.7.1 +oauthlib==3.2.2 +paramiko==3.3.1 +passlib==1.7.4 +pgadmin4==7.8 +portalocker==2.8.2 +protobuf==4.24.4 +psutil==5.9.6 +psycopg==3.1.12 +psycopg-binary==3.1.12 +pyasn1==0.5.0 +pyasn1-modules==0.3.0 +pycparser==2.21 +PyJWT==2.8.0 +PyNaCl==1.5.0 +pyotp==2.9.0 +pyparsing==3.1.1 +pypng==0.20220715.0 +python-dateutil==2.8.2 +python-engineio==4.8.0 +python-socketio==5.10.0 +pytz==2023.3.post1 +qrcode==7.4.2 +requests==2.31.0 +requests-oauthlib==1.3.1 +rsa==4.9 +s3transfer==0.7.0 +SecretStorage==3.3.3 +simple-websocket==1.0.0 +six==1.16.0 +speaklater3==1.4 +SQLAlchemy==2.0.22 +sqlparse==0.4.4 +sshtunnel==0.4.0 +typing_extensions==4.8.0 +ua-parser==0.18.0 +uritemplate==4.1.1 +urllib3==1.26.18 +user-agents==2.2.0 +Werkzeug==2.2.3 +wsproto==1.2.0 +WTForms==3.0.1 +zipp==3.17.0 -- 2.34.1