Packaging: Sync from boilerplate.

Author: Gadgetoid

.github/workflows/build.yml

@@ -28,7 +28,7 @@ jobs:
 
       - name: Install Dependencies
         run: |
-          make build-deps
+          make dev-deps
 
       - name: Build Packages
         run: |

.github/workflows/qa.yml

@@ -21,7 +21,7 @@ jobs:
 
       - name: Install Dependencies
         run: |
-          make test-deps
+          make dev-deps
 
       - name: Run Quality Assurance
         run: |

.github/workflows/test.yml

@@ -25,7 +25,7 @@ jobs:
 
       - name: Install Dependencies
         run: |
-          make test-deps
+          make dev-deps
 
       - name: Run Tests
         run: |

Makefile

@@ -1,37 +1,35 @@
-LIBRARY_NAME="ioexpander"
-LIBRARY_VERSION=$(shell grep __version__ ${LIBRARY_NAME}/__init__.py | awk -F" = " '{print substr($$2,2,length($$2)-2)}' | awk -F"." '{print $$1"."$$2"."$$3}')
+LIBRARY_NAME := $(shell hatch project metadata name 2> /dev/null)
+LIBRARY_VERSION := $(shell hatch version 2> /dev/null)
 
 .PHONY: usage install uninstall check pytest qa build-deps check tag wheel sdist clean dist testdeploy deploy
 usage:
+ifdef LIBRARY_NAME
 	@echo "Library: ${LIBRARY_NAME}"
 	@echo "Version: ${LIBRARY_VERSION}\n"
+else
+	@echo "WARNING: You should 'make dev-deps'\n"
+endif
 	@echo "Usage: make <target>, where target is one of:\n"
 	@echo "install:      install the library locally from source"
 	@echo "uninstall:    uninstall the local library"
-	@echo "build-deps:   install essential python build dependencies"
-	@echo "test-deps:    install essential python test dependencies"
+	@echo "dev-deps:     install Python dev dependencies"
 	@echo "check:        perform basic integrity checks on the codebase"
 	@echo "qa:           run linting and package QA"
-	@echo "pytest:       run python test fixtures"
-	@echo "wheel:        build python .whl files for distribution"
-	@echo "sdist:        build python source distribution"
-	@echo "clean:        clean python build and dist directories"
-	@echo "dist:         build all python distribution files"
-	@echo "testdeploy:   build all and deploy to test PyPi"
-	@echo "deploy:       build all and deploy to PyPi"
-	@echo "tag:          tag the repository with the current version"
+	@echo "pytest:       run Python test fixtures"
+	@echo "clean:        clean Python build and dist directories"
+	@echo "build:        build Python distribution files"
+	@echo "testdeploy:   build and upload to test PyPi"
+	@echo "deploy:       build and upload to PyPi"
+	@echo "tag:          tag the repository with the current version\n"
 
 install:
 	./install.sh --unstable
 
 uninstall:
 	./uninstall.sh
 
-build-deps:
-	python3 -m pip install build
-
-test-deps:
-	python3 -m pip install tox
+dev-deps:
+	python3 -m pip install -r requirements-dev.txt
 	sudo apt install dos2unix
 
 check:
@@ -49,20 +47,14 @@ nopost:
 tag:
 	git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}"
 
-wheel: check
-	python3 -m build --wheel
-
-sdist: check
-	python3 -m build --sdist
+build: check
+	@hatch build
 
 clean:
 	-rm -r dist
 
-dist: clean wheel sdist
-	ls dist
-
-testdeploy: dist
+testdeploy: build
 	twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 
-deploy: nopost dist
+deploy: nopost build
 	twine upload dist/*

check.sh

@@ -3,9 +3,9 @@
 # This script handles some basic QA checks on the source
 
 NOPOST=$1
-LIBRARY_NAME="ioexpander"
-LIBRARY_VERSION=`grep __version__ $LIBRARY_NAME/__init__.py | awk -F" = " '{print substr($2,2,length($2)-2)}' | awk -F "." '{print $1"."$2"."$3}'`
-POST_VERSION=`grep __version__ $LIBRARY_NAME/__init__.py | awk -F" = " '{print substr($2,2,length($2)-2)}' | awk -F "." '{print substr($4,0,length($4))}'`
+LIBRARY_NAME=`hatch project metadata name`
+LIBRARY_VERSION=`hatch version | awk -F "." '{print $1"."$2"."$3}'`
+POST_VERSION=`hatch version | awk -F "." '{print substr($4,0,length($4))}'`
 
 success() {
 	echo -e "$(tput setaf 2)$1$(tput sgr0)"
@@ -36,6 +36,7 @@ while [[ $# -gt 0 ]]; do
 	esac
 done
 
+inform "Checking $LIBRARY_NAME $LIBRARY_VERSION\n"
 
 inform "Checking for trailing whitespace..."
 grep -IUrn --color "[[:blank:]]$" --exclude-dir=dist --exclude-dir=.tox --exclude-dir=.git --exclude=PKG-INFO

pyproject.toml

@@ -54,9 +54,13 @@ include = [
     "LICENSE"
 ]
 
-[tool.hatch.build.targets.dist]
+[tool.hatch.build.targets.sdist]
 include = [
-    "/examples"
+    "*"
+]
+exclude = [
+    ".*",
+    "dist"
 ]
 
 [tool.hatch.metadata.hooks.fancy-pypi-readme]
@@ -91,6 +95,9 @@ skip = """
 ./dist.\
 """
 
+[tool.isort]
+line_length = 220
+
 [tool.check-manifest]
 ignore = [
     '.stickler.yml',

requirements-dev.txt

@@ -0,0 +1,8 @@
+check-manifest
+ruff
+codespell
+isort
+twine
+hatch
+hatch-fancy-pypi-readme
+tox

tox.ini

@@ -2,7 +2,7 @@
 envlist = py,qa
 skip_missing_interpreters = True
 isolated_build = true
-minversion = 3.3.0
+minversion = 4.0.0
 
 [testenv]
 commands =
@@ -19,12 +19,14 @@ commands =
 	check-manifest
 	python -m build --no-isolation
 	python -m twine check dist/*
+	isort --check .
 	ruff --format=github .
 	codespell .
 deps =
 	check-manifest
 	ruff
 	codespell
+	isort
 	twine
 	build
 	hatch