Use poetry and dev container

Author: codedstructure

.gitignore

@@ -1,12 +1,13 @@
 *.pyc
 *.pyo
+
 .idea
+.vscode
+
 .DS_Store
+
 build
 dist
 docs/_build
-MANIFEST
-pylibftdi.egg-info
-.coverage
-htmlcov
-.hg
+
+.venv

.hgignore

@@ -0,0 +1,18 @@
+# Defines an ubuntu-based dev container for development and testing of pylibftdi
+
+# As well as providing poetry etc, this pre-installs the required libftdi1-2
+# package, providing libftdi 1.5 (as of Ubuntu 22.04) and all its dependencies.
+
+FROM ubuntu:22.04
+WORKDIR /app
+RUN \
+  apt-get update; \
+  apt-get install -y libftdi1-2 python3-minimal python3-pip python3-poetry vim; \
+  ln -s /usr/bin/python3 /usr/bin/python; # Workaround for https://github.com/python-poetry/poetry/issues/6371
+
+# Use in-project venvs so subsequent `poetry install` operations are quick
+ENV POETRY_VIRTUALENVS_IN_PROJECT=true
+# Required for `poetry shell` to detect the shell
+ENV SHELL=/bin/bash
+
+CMD ["bash"]

Dockerfile

@@ -0,0 +1,33 @@
+# Basic development functions for pylibftdi.
+
+# Example:
+#   make container && make lint && make test && make build
+
+.PHONY: all
+all: container test lint build
+
+.PHONY: container
+container:
+	docker build -t pylibftdi-dev:latest .
+
+.PHONY: build
+build:
+	docker run -t -v $$PWD:/app -w /app pylibftdi-dev:latest poetry build
+
+.PHONY: test
+test:
+	docker run -t -v $$PWD:/app -w /app pylibftdi-dev:latest bash -c 'poetry install && poetry run pytest'
+
+.PHONY: lint
+lint:
+	docker run -t -v $$PWD:/app -w /app pylibftdi-dev:latest bash -c 'poetry install && (poetry run ruff src tests; poetry run mypy src)'
+
+.PHONY: shell
+shell:
+	# Drop into a poetry shell where e.g. `python3 -m pylibftdi.examples.list_devices` etc can be run
+	docker run -it -v $$PWD:/app -w /app pylibftdi-dev:latest bash -ic 'poetry install && poetry shell'
+
+.PHONY: clean
+clean:
+	# Ideally this would remove all relevant dev containers too...
+	rm -rf dist/ .venv/

MANIFEST.in

@@ -1,14 +1,15 @@
-[project]
+[tool.poetry]
 name = "pylibftdi"
 version="0.20.0"
-readme = "README.rst"
 description = "Pythonic interface to FTDI devices using libftdi."
+license = "MIT"
 authors = [
-    {name = "Ben Bass", email = "benbass@codedstructure.net"}
+    "Ben Bass <benbass@codedstructure.net>",
 ]
-license = {file = "LICENSE.txt"}
-requires-python = ">=3.7.0"
-dependencies = []
+readme = "README.rst"
+homepage = "https://github.com/codedstructure/pylibftdi"
+repository = "https://github.com/codedstructure/pylibftdi"
+documentation = "https://pylibftdi.readthedocs.io/en/latest/"
 keywords = [
     "ftdi",
     "libftdi",
@@ -33,17 +34,29 @@ classifiers = [
     "Topic :: System :: Hardware",
 ]
 
-[project.urls]
-repository = "https://github.com/codedstructure/pylibftdi"
-documentation = "https://pylibftdi.readthedocs.io/en/latest/"
-changelog = "https://github.com/codedstructure/pylibftdi/blob/main/CHANGES.txt"
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.dependencies]
+python = ">=3.7.0"
 
-[bdist_wheel]
-universal = 1
+[tool.poetry.dev-dependencies]
+pytest = "^7.3.1"
+ruff = "^0.0.263"
+mypy = "^1.2.0"
 
 [tool.ruff]
 select = ["E", "W", "F", "B", "I", "UP", "PL"]
 ignore = [
   "PLR2004",  # Magic value used in comparison
   "PLR0913",  # Too many arguments to function call
 ]
+
+[tool.pytest.ini_options]
+pythonpath = [
+    "src", ".",
+]
+addopts = [
+    "--import-mode=importlib",
+]

Makefile

@@ -15,6 +15,7 @@
 
 from pylibftdi import FtdiError
 from pylibftdi.bitbang import BitBangDevice
+
 from tests.test_common import CallCheckMixin, LoopDevice
 
 

poetry.lock

@@ -15,6 +15,7 @@
 
 from pylibftdi import FtdiError
 from pylibftdi.device import Device
+
 from tests.test_common import CallCheckMixin, LoopDevice
 
 # and now some test cases...

pyproject.toml

@@ -14,6 +14,7 @@
 import unittest
 
 from pylibftdi.serial_device import SerialDevice
+
 from tests.test_common import CallCheckMixin, LoopDevice