python-update-checker 0.5__tar.gz

python_update_checker-0.5/.gitignore

@@ -0,0 +1,25 @@
+# generated python files
+__pycache__
+/.pytest_cache
+/.ruff_cache
+/uv.lock
+/.venv
+
+# build and dist dirs
+/build
+/dist
+/.achievements
+/MANIFEST
+
+# configuration for direnv(1)
+/.envrc
+
+# local development files
+/bin
+/.python-version
+
+# todo.txt files
+/todo.txt
+/todo.txt.bak
+/done.txt
+/report.txt

python_update_checker-0.5/.ruff.toml

@@ -0,0 +1,47 @@
+target-version = "py311"
+
+[lint]
+select = [
+    "E", # pycodestyle
+    "F", # pyflakes
+    "B", # flake8-bugbear
+    "I", # isort
+    "D", # pydocstyle
+    "FIX", # fixme
+    "FA", # future-annotation
+    "LOG", # logging
+    "INP", # PEP420
+    "PIE", # flake8-pie
+    "RSE", # flake8-raise
+    "RET", # flake8-return
+    "PLC", # pylint convention
+    "PLE", # pylint error
+    "PLW", # pylint warning
+    "RUF", # ruff
+    "UP", # pyupgrade
+    "YTT", # flake8-2020
+]
+
+# Ignored rules
+ignore = [
+    "E501", # line-too-long
+    "I001", # unsorted-imports
+    "D205", # blank-line-after-summary
+    "D402", # no-signature
+    "D415", # ends-in-punctuation
+    "D417", # undocumented-param
+]
+
+
+[lint.per-file-ignores]
+
+[lint.isort]
+known-first-party = []
+section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]
+force-sort-within-sections = false
+
+[lint.pydocstyle]
+convention = "google"
+
+[format]
+quote-style = "preserve"

python_update_checker-0.5/Makefile

@@ -0,0 +1,188 @@
+# This Makefile is only used by developers.
+
+############# Settings ############
+# use Bash as shell, not sh
+SHELL := bash
+# execute makefile in a single bash process instead of one per target
+.ONESHELL:
+# set Bash flags
+.SHELLFLAGS := -eu -o pipefail -c
+# remove target files if a rule fails, forces reruns of aborted rules
+.DELETE_ON_ERROR:
+# warn for undefined variables
+MAKEFLAGS += --warn-undefined-variables
+# disable builtin default rules
+MAKEFLAGS += --no-builtin-rules
+
+
+############ Configuration ############
+PROJECT:=$(shell egrep "name[[:space:]]*=" pyproject.toml | cut -d'"' -f2)
+VERSION:=$(shell egrep "version[[:space:]]*=" pyproject.toml | cut -d'"' -f2)
+
+# exclude packages that are newer than this
+EXCLUDE_NEWER:="7 days"
+# Pytest options:
+# --full-trace: print full stacktrace on errors
+PYTESTOPTS?=--full-trace
+# which test modules to run
+TESTS ?= tests/
+# set test options
+TESTOPTS=
+# python files and directories
+PY_FILES_DIRS:=\
+  src \
+  tests
+
+# Release configuration
+RELEASE_NAME:=$(subst -,_,$(PROJECT))-$(VERSION)
+RELEASE_SOURCE:=$(RELEASE_NAME).tar.gz
+RELEASE_WHEEL:=$(RELEASE_NAME)-py3-none-any.whl
+RELEASE_BRANCH:=main
+RELEASE_TAG:=$(VERSION)
+
+
+############ Default target ############
+
+# `make help` displays all targets documented with `##`in the target line
+.PHONY: help
+help:	## display this help section
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9_-]+:.*?## / {printf "\033[36m%-38s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+.DEFAULT_GOAL := help
+
+
+############ Installation and provisioning  ############
+
+.PHONY: init
+init: ## install python virtual env and required development packages
+	uv sync
+
+
+############ Linting and syntax checks ############
+
+.PHONY: lint
+lint: lint-py lint-shell
+
+.PHONY: lint-py
+lint-py: ## lint python code
+	ruff check $(PY_FILES_DIRS)
+
+.PHONY: lint-shell
+lint-shell:
+	shellcheck -x scripts/*.sh
+
+.PHONY: audit
+audit: ## run audit checks
+	uv audit
+
+.PHONY: reformat
+reformat: ## format the python code
+	ruff check --fix $(PY_FILES_DIRS)
+	ruff format $(PY_FILES_DIRS)
+
+.PHONY: checkoutdated checkoutdated-py checkoutdated-gh
+checkoutdated: checkoutdated-py checkoutdated-gh
+
+checkoutdated-py:	## Check for outdated package requirements
+	uv run puc --exclude-newer=$(EXCLUDE_NEWER) check pyproject.toml
+
+checkoutdated-gh:	## check for outdated github projects
+# github-check-outdated is a local tool which compares a given version with the latest available github release version
+# see https://gist.github.com/wummel/ef14989766009effa4e262b01096fc8c for an example implementation
+	@echo "Check for outdated Github tools"
+	github-check-outdated astral-sh uv "$(shell uv --version | cut -f2 -d" ")"
+	github-check-outdated python cpython v$(shell python --version | cut -f2 -d" ") '^v3\.14\.[0-9]+$$'
+
+
+.PHONY: upgradeoutdated
+upgradeoutdated:	upgradeoutdated-gh upgradeoutdated-py
+
+.PHONY: upgradeoutdated-gh
+upgradeoutdated-gh:
+	sed -i -e 's/uv_version_dev = ".*"/uv_version_dev = "$(shell github-check-outdated astral-sh uv 0 | cut -f4 -d" ")"/' pyproject.toml
+	sed -i -e 's/python_version_dev = ".*"/python_version_dev = "$(shell github-check-outdated python cpython 0 '^v3\.14\.[0-9]+$$' | cut -f4 -d" " | cut -b2-)"/' pyproject.toml
+	scripts/install_dev.sh
+
+.PHONY: upgradeoutdated-py
+upgradeoutdated-py:	## upgrade dependencies in pyproject.toml and uv.lock
+	# upgrade pyproject.toml dependencies
+	uv run puc --exclude-newer=$(EXCLUDE_NEWER) update pyproject.toml
+	# upgrade depencencies in uv lock file
+	uv lock --exclude-newer=$(EXCLUDE_NEWER) --upgrade
+	# install upgraded package versions in virtual environment
+	$(MAKE) init
+
+
+############ Testing ############
+
+.PHONY: test
+test: ## run tests
+	uv run --isolated -- pytest $(PYTESTOPTS) $(TESTOPTS) $(TESTS)
+
+.PHONY: typecheck
+typecheck:	## run the ty type checker
+	ty check $(PY_FILES_DIRS)
+
+
+############ Release  ############
+
+.PHONY: distclean
+distclean:
+	rm -rf dist $(shell find src tests -type d -name __pycache__)
+
+.PHONY: dist
+dist:
+	uv build
+
+# Releases are tagged with the version, ie. "0.5"
+.PHONY: release
+release: distclean checkrelease	## create release
+	$(MAKE) dist release-gh release-pypi
+
+# export GITHUB_TOKEN for the gh command
+# Generate a fine grained access token with:
+# - Restricted to this repository
+# - Repository permission: Metadata -> Read (displayed as "Read access to metadata" in token view)
+# - Repository permission: Contents -> Read and write (displayed as "Read and Write access to code" in token view)
+# - Expiration in 90 days
+# After that run "export GITHUB_TOKEN=<token-content>"
+.PHONY: release-gh
+release-gh:	## upload a new release to github
+	gh release create \
+	  --title "Release $(RELEASE_TAG)" \
+	  --notes-from-tag \
+	  --latest \
+	  --draft=false \
+	  --prerelease=false \
+	  --verify-tag \
+	  "$(RELEASE_TAG)" \
+	  dist/$(RELEASE_SOURCE)
+
+.PHONY: release-pypi
+release-pypi: ## upload a new release to pypi
+	uv publish dist/$(RELEASE_SOURCE) dist/$(RELEASE_WHEEL)
+
+.PHONY: checkrelease
+checkrelease: lint test typecheck checkgit	## check release conditions
+
+.PHONY: checkgit
+checkgit:	## various git release checks
+# check that the current branch is the release branch
+	@if [ "$(shell git rev-parse --abbrev-ref HEAD)" != "$(RELEASE_BRANCH)" ]; then \
+	  echo "ERROR: current branch is not '$(RELEASE_BRANCH)', but '$(shell git rev-parse --abbrev-ref HEAD;)'"; \
+	  false; \
+	fi
+# check for uncommitted versions
+	@if [ -n "$(shell git status --porcelain --untracked-files=all)" ]; then \
+	  echo "ERROR: uncommitted changes"; \
+	  git status --porcelain --untracked-files=all; \
+	  false; \
+	fi
+# check that release tag exists
+	@if [ -z "$(shell git tag -l -- $(RELEASE_TAG))" ]; then \
+	  echo "ERROR: git tag \"$(RELEASE_TAG)\" does not exist, execute 'git tag -a $(RELEASE_TAG) -m \"$(RELEASE_TAG)\"'"; \
+	  false; \
+	fi
+# check that release tags is pushed to remote
+	@if ! git ls-remote --exit-code --tags origin $(RELEASE_TAG); then \
+	  echo "ERROR: git tag \"$(RELEASE_TAG)\" does not exist on remote repo, execute 'git push --tags'"; \
+	fi

python_update_checker-0.5/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: python-update-checker
+Version: 0.5
+License-Expression: GPL-3.0-only
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 4 - Beta
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Dist: packaging>=26.1
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+python-update-checker
+======================
+Python-update-checker (puc) checks or updates pinned dependencies
+in `pyproject.toml`, `requirements.txt` or `uv.lock` files.
+
+See https://github.com/astral-sh/uv/issues/6794 for a discussion
+about different pinning strategies.
+
+
+Features
+---------
+
+* updates pinned dependencies, ignores unpinned dependencies
+* supports pyproject.toml, uv.lock and requirements.txt formats
+* supports `[project.dependencies]`, `[project.optional-dependencies]` and `[dependency-groups]` in pyproject.toml
+* supports recursive references (-r) in requirements.txt formats
+* can run in check only mode, ie. it checks if updates are available
+* limit updates to specific packages
+* limit updates with package version constraints (ie. "django<6")
+* limit updates to versions that were uploaded prior to a given date
+* (limited) support for environment markers, ie. `"pywin32==311; os_name=='nt'"`
+* runs on Linux, MacOS and Windows platforms
+
+
+Examples
+---------
+
+```bash
+$ # check all pinned packages for updates in pyproject.toml
+$ puc check pyproject.toml
+puc INFO: check pyproject file pyproject.toml
+puc WARNING: found update 'ty==0.0.29' --> 0.0.32
+
+$ # update all pinned packages in pyproject.toml
+$ # limit updates to versions that are at least 7 days old
+$ puc --exclude-newer="7 days" update pyproject.toml
+puc INFO: update pyproject file pyproject.toml
+puc INFO: updating 'ty==0.0.29' --> 0.0.31
+puc INFO: Wrote 1 updated package version(s) to pyproject.toml
+
+$ # check all pinned packages for updates in requirements.txt
+$ puc check requirements.txt
+puc INFO: check requirements file requirements.txt
+puc WARNING: found update 'argcomplete==3.6.1' --> 3.6.3
+puc WARNING: found update 'Django==5.2.0' --> 6.0.4
+
+$ # update only the django package version in requirements.txt
+$ # limit updates to django versions less than 6
+$ puc --package="Django" --constraints="Django<6" update requirements.txt
+INFO: update requirements file requirements.txt
+INFO: updating 'Django==5.2.0' --> 5.2.13
+INFO: Wrote 1 updated package version(s) to requirements.txt
+```
+
+Script behaviour
+-----------------
+
+The exit code of `puc check` is non-zero when updates are available.
+
+Checking a `pyproject.toml` or `uv.lock`file with `puc` should be done
+from the project of the `pyproject.toml` file,
+especially if your project relies on a [project directory](https://docs.astral.sh/uv/concepts/projects/layout/) (for example to define additional packages index in pyproject.toml).
+
+After updating versions in pyproject.toml, run `uv lock --upgrade` to update
+the transitive dependencies in `uv.lock`.
+
+Pinned dependencies are packages with `==` or `===` constraints and no wildcards in the version.
+
+
+Installation
+-------------
+
+1) Install [python uv](https://docs.astral.sh/uv/getting-started/installation/)
+2) Install puc with `uv pip install python-update-checker`.
+
+
+
+Architecture
+-------------
+
+Dependencies are
+
+* [uv](https://docs.astral.sh/uv/):
+  The uv binary must be available for the script to call.  
+  puc uses `echo "package" | uv pip compile -` to get latest package versions.  
+  puc uses `uv add "package==<version>"` to update pyproject.toml dependencies.
+
+* [packaging](https://packaging.pypa.io/):
+  Parses dependencies with the packaging.requirements.Requirement class.
+
+puc needs Python >= 3.11 since it uses the tomllib Python module.
+
+puc consists of a single python script. The script uses [inline script metadata](https://peps.python.org/pep-0723/) to be executed directly with `uv run --script`.  
+This enables simple packaging and installation.
+
+
+Limitations
+------------
+
+* No support for custom dependency formats in pyproject.toml
+  (eg. `[tool.poetry.dependencies]`).
+* puc has limited support for environment markers.
+* Constraint references (`-c`) inside requirements.txt are not supported.  
+  Use the `--constraints` option instead.

python_update_checker-0.5/README.md

@@ -0,0 +1,104 @@
+python-update-checker
+======================
+Python-update-checker (puc) checks or updates pinned dependencies
+in `pyproject.toml`, `requirements.txt` or `uv.lock` files.
+
+See https://github.com/astral-sh/uv/issues/6794 for a discussion
+about different pinning strategies.
+
+
+Features
+---------
+
+* updates pinned dependencies, ignores unpinned dependencies
+* supports pyproject.toml, uv.lock and requirements.txt formats
+* supports `[project.dependencies]`, `[project.optional-dependencies]` and `[dependency-groups]` in pyproject.toml
+* supports recursive references (-r) in requirements.txt formats
+* can run in check only mode, ie. it checks if updates are available
+* limit updates to specific packages
+* limit updates with package version constraints (ie. "django<6")
+* limit updates to versions that were uploaded prior to a given date
+* (limited) support for environment markers, ie. `"pywin32==311; os_name=='nt'"`
+* runs on Linux, MacOS and Windows platforms
+
+
+Examples
+---------
+
+```bash
+$ # check all pinned packages for updates in pyproject.toml
+$ puc check pyproject.toml
+puc INFO: check pyproject file pyproject.toml
+puc WARNING: found update 'ty==0.0.29' --> 0.0.32
+
+$ # update all pinned packages in pyproject.toml
+$ # limit updates to versions that are at least 7 days old
+$ puc --exclude-newer="7 days" update pyproject.toml
+puc INFO: update pyproject file pyproject.toml
+puc INFO: updating 'ty==0.0.29' --> 0.0.31
+puc INFO: Wrote 1 updated package version(s) to pyproject.toml
+
+$ # check all pinned packages for updates in requirements.txt
+$ puc check requirements.txt
+puc INFO: check requirements file requirements.txt
+puc WARNING: found update 'argcomplete==3.6.1' --> 3.6.3
+puc WARNING: found update 'Django==5.2.0' --> 6.0.4
+
+$ # update only the django package version in requirements.txt
+$ # limit updates to django versions less than 6
+$ puc --package="Django" --constraints="Django<6" update requirements.txt
+INFO: update requirements file requirements.txt
+INFO: updating 'Django==5.2.0' --> 5.2.13
+INFO: Wrote 1 updated package version(s) to requirements.txt
+```
+
+Script behaviour
+-----------------
+
+The exit code of `puc check` is non-zero when updates are available.
+
+Checking a `pyproject.toml` or `uv.lock`file with `puc` should be done
+from the project of the `pyproject.toml` file,
+especially if your project relies on a [project directory](https://docs.astral.sh/uv/concepts/projects/layout/) (for example to define additional packages index in pyproject.toml).
+
+After updating versions in pyproject.toml, run `uv lock --upgrade` to update
+the transitive dependencies in `uv.lock`.
+
+Pinned dependencies are packages with `==` or `===` constraints and no wildcards in the version.
+
+
+Installation
+-------------
+
+1) Install [python uv](https://docs.astral.sh/uv/getting-started/installation/)
+2) Install puc with `uv pip install python-update-checker`.
+
+
+
+Architecture
+-------------
+
+Dependencies are
+
+* [uv](https://docs.astral.sh/uv/):
+  The uv binary must be available for the script to call.  
+  puc uses `echo "package" | uv pip compile -` to get latest package versions.  
+  puc uses `uv add "package==<version>"` to update pyproject.toml dependencies.
+
+* [packaging](https://packaging.pypa.io/):
+  Parses dependencies with the packaging.requirements.Requirement class.
+
+puc needs Python >= 3.11 since it uses the tomllib Python module.
+
+puc consists of a single python script. The script uses [inline script metadata](https://peps.python.org/pep-0723/) to be executed directly with `uv run --script`.  
+This enables simple packaging and installation.
+
+
+Limitations
+------------
+
+* No support for custom dependency formats in pyproject.toml
+  (eg. `[tool.poetry.dependencies]`).
+* puc has limited support for environment markers.
+* Constraint references (`-c`) inside requirements.txt are not supported.  
+  Use the `--constraints` option instead.

python_update_checker-0.5/pyproject.toml

@@ -0,0 +1,59 @@
+[project]
+name = "python-update-checker"
+version = "0.5"
+requires-python = ">=3.11"
+license = "GPL-3.0-only"
+license_files = [
+    "COPYING",
+]
+readme = "README.md"
+# https://pypi.org/classifiers/
+classifiers = [
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Development Status :: 4 - Beta",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Build Tools",
+]
+dependencies = [
+  # track compatibility for dependencies, do not pin
+  "packaging>=26.1",
+]
+
+[project.scripts]
+puc = "puc:cli.main"
+
+[dependency-groups]
+# these packages are only needed for development
+dev = [
+  # for python code linting
+  "ruff==0.15.12",
+  # for python type checking
+  "ty==0.0.34",
+  # for testing
+  "pytest==9.0.3",
+]
+
+[build-system]
+requires = ["uv_build>=0.11,<0.12"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "puc"
+source-include = [
+  ".gitignore",
+  ".ruff.toml",
+  "Makefile",
+  "scripts/**",
+  "tests/**",
+]
+
+[tool.project]
+# pin versions of Python and uv for development
+python_version_dev = "3.14.4"
+uv_version_dev = "0.11.11"

python_update_checker-0.5/scripts/install_dev.sh

@@ -0,0 +1,113 @@
+#!/bin/bash
+#
+# Description: set up a development environment ready for developing this software
+#  Package installation uses apt-get which requires sudo permissions
+# Requirements: a Debian-based Linux system and sudo permissions for the current user
+# Synopsis: scripts/install_dev.sh
+
+#### shell settings
+# abort when using unknown variables
+set -o nounset
+# abort on subprogram errors
+set -o errexit
+# abort on piping errors (ie. a|b, a fails)
+set -o pipefail
+# subshells should inherit error handlers/traps (set -E)
+set -o errtrace
+# for debugging: print every command with TRACE=1
+if [[ "${TRACE-0}" == "1" ]]; then
+    set -o xtrace
+fi
+
+# command substitution inherits the errexit setting
+shopt -s inherit_errexit
+# do not print file globbing patters when no file exists
+shopt -s nullglob
+
+#### configuration variables
+# the directory this script is stored
+BASEDIR=$(realpath "$(dirname "${0}")")
+# the project directory
+PROJECTDIR=$(dirname "${BASEDIR}")
+
+PY_VER=$(grep "python_version_dev =" "${PROJECTDIR}/pyproject.toml" | cut -f2 -d'"')
+UV_VER=$(grep "uv_version_dev =" "${PROJECTDIR}/pyproject.toml" | cut -f2 -d'"')
+DOWNLOAD_URL_UV=https://github.com/astral-sh/uv/releases/download/${UV_VER}/uv-x86_64-unknown-linux-gnu.tar.gz
+CURL_OPTS=("--location" "--silent" "--show-error" "--retry" "2" "--fail" "--tlsv1.2" "--proto" "=https")
+REINSTALL_PYTHON=0
+
+
+#### helper functions
+
+# Install a debian package
+install_package() {
+  local pkg=$1
+  if ! dpkg --status "${pkg}" >/dev/null 2>&1; then
+    echo "Installing ${pkg}"
+    sudo apt-get install "${pkg}"
+  fi
+}
+
+#### main function
+
+# execute make targets
+install_package make
+# download tool
+install_package curl
+# augment the local environment
+install_package direnv
+# lint shell
+install_package shellcheck
+
+# the rest of this scripts relies on being in the project directory
+cd "${PROJECTDIR}"
+
+# install uv
+if [ ! -d bin ]; then
+    mkdir bin
+fi
+if [ ! -f bin/uv ]; then
+    echo "Install uv ${UV_VER} from ${DOWNLOAD_URL_UV}"
+    (cd bin; curl "${CURL_OPTS[@]}" "${DOWNLOAD_URL_UV}" | tar xzv --strip-components 1)
+elif [ "$(bin/uv --version | cut -d" " -f2)" != "${UV_VER}" ]; then
+    echo "Updating $(bin/uv --version) to ${UV_VER} from ${DOWNLOAD_URL_UV}"
+    (cd bin; curl "${CURL_OPTS[@]}" "${DOWNLOAD_URL_UV}" | tar xzv --strip-components 1)
+    # new uv versions might use new versions from python-build-standalone
+    REINSTALL_PYTHON=1
+fi
+
+# add local development environment for direnv
+if ! declare -F _direnv_hook >/dev/null; then
+    eval "$(direnv hook bash)"
+fi
+if [ ! -f .envrc ]; then
+    (
+    echo "# to find local tools"
+    echo "export PATH=${PROJECTDIR}/bin\${PATH:+:\$PATH}"
+    echo "export PATH=${PROJECTDIR}/.venv/bin\${PATH:+:\$PATH}"
+    ) > .envrc
+    direnv allow .
+    source .envrc
+fi
+
+# create .python-version
+if [ ! -f .python-version ]; then
+  echo "Generating $PROJECTDIR/.python-version"
+  echo "${PY_VER}" > .python-version
+else
+  PROJ_PY_VER=$(<.python-version)
+  if [ ".$PROJ_PY_VER" != ".$PY_VER" ]; then
+    echo "Updating $PROJECTDIR/.python-version (${PROJ_PY_VER} -> ${PY_VER})"
+    echo "${PY_VER}" >| .python-version
+    rm -rf .venv
+  fi
+fi
+
+# create virtual environment
+if [ ! -d .venv ]; then
+    uv venv
+fi
+
+if [ "${REINSTALL_PYTHON}" = "1" ]; then
+    uv python install --reinstall
+fi

python_update_checker-0.5/src/puc/__init__.py

@@ -0,0 +1,3 @@
+# Author: Bastian Kleineidam
+# Copyright: GPL-v3
+"""module file"""