Switch from Setuptools to Hatch. (Attempt 2.) (#3)

* Changed `pyproject.toml` settings to use Hatch.
* Build failed because of no Setuptools. Added.
* Removed Setuptools dependency.
  * It is not needed. Clang was needed.
* Added build workflow.
* Verbose logging in GitHub Actions workflow.
* Renamed 'build' workflow to 'install'.
  * Building means creating an installable package
  * This workflow installs the package in development mode.
* Added lint workflow.
* Removed `Makefile` since Hatch can build and publish.
* Fixed some lints.
* Lint ignore rules for `__init__.py`.
* Fixed more lints.
* Fixed invalid module names.
  * Except the main module, `ScrollableContainers`.
  * I have already registered it on PyPI, so this invalid name will have to stay.
* Ran `hatch fmt`.
* Reduced maximum width of docstrings to 79 characters.
  * `hatch fmt` indented them outwards without wrapping them.
* Added build workflow.
* Reduced verbosity of build and format workflows.
* Changed version to alpha 0.
  * Since I have made no releases with this major version number yet, it is okay to change it to a pre-release version.
  * I plan to use alpha releases to see how it looks on PyPI rather than using TestPyPI.

Author: tfpf

.github/workflows/build.yml

@@ -0,0 +1,11 @@
+name: build
+on: [push, workflow_dispatch]
+
+jobs:
+  build:
+    name: build on ubuntu-22.04
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - run: pipx install hatch
+      - run: hatch build

.github/workflows/install.yml

@@ -0,0 +1,12 @@
+name: install
+on: [push, workflow_dispatch]
+
+jobs:
+  install:
+    name: install on ubuntu-22.04
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - run: pipx install hatch
+      - run: sudo apt install libgtk-3-dev
+      - run: hatch -vv env create dev

.github/workflows/lint.yml

@@ -0,0 +1,11 @@
+name: lint
+on: [push, workflow_dispatch]
+
+jobs:
+  lint:
+    name: lint on ubuntu-22.04
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - run: pipx install hatch
+      - run: hatch fmt --check

Makefile

@@ -20,6 +20,10 @@ Scrollable containers are currently available for the following GUI toolkits.
 to: the Tcl Core Team, the Python Software Foundation, the wxWidgets Team, the wxPython Team, the Qt Company and
 Riverbank Computing.**
 
+[![lint](https://github.com/tfpf/ScrollableContainers/actions/workflows/lint.yml/badge.svg)](https://github.com/tfpf/ScrollableContainers/actions/workflows/lint.yml)
+[![install](https://github.com/tfpf/ScrollableContainers/actions/workflows/install.yml/badge.svg)](https://github.com/tfpf/ScrollableContainers/actions/workflows/install.yml)
+[![build](https://github.com/tfpf/ScrollableContainers/actions/workflows/build.yml/badge.svg)](https://github.com/tfpf/ScrollableContainers/actions/workflows/build.yml)
+
 # Tkinter
 `ScrollableContainers.ScrollableFrameTk`: a comprehensive implementation of a scrollable frame, and the flagship class
 of this project. (I wrote the other classes just for completeness.)

README.md

@@ -1,21 +1,20 @@
 #! /usr/bin/env python3
 
 import itertools
+
 from PyQt5.QtCore import QSize
 from PyQt5.QtWidgets import QApplication, QGridLayout, QLabel, QMainWindow, QVBoxLayout
-
 from ScrollableContainers import ScrollableAreaQt5
 
 
 class ExamplesScrollableAreaQt5:
-
     def __init__(self):
         self.grid_of_widgets(QMainWindow())
         self.single_widget(QMainWindow())
 
     def grid_of_widgets(self, window):
         self.win1 = window
-        window.setWindowTitle('`ScrollableAreaQt5` demo')
+        window.setWindowTitle("`ScrollableAreaQt5` demo")
 
         # Create a scrollable area.
         scrollable_area = ScrollableAreaQt5()
@@ -24,29 +23,29 @@ def grid_of_widgets(self, window):
         # the scrollable area itself.
         dim = 10
         grid_layout = QGridLayout(scrollable_area.area)
-        for (i, j) in itertools.product(range(dim), repeat=2):
-            label = QLabel(text=f'Label\n({i}, {j})')
+        for i, j in itertools.product(range(dim), repeat=2):
+            label = QLabel(text=f"Label\n({i}, {j})")
             grid_layout.addWidget(label, i, j)
 
         window.setCentralWidget(scrollable_area)
         window.show()
 
     def single_widget(self, window):
         self.win2 = window
-        window.setWindowTitle('`ScrollableAreaQt5` demo')
+        window.setWindowTitle("`ScrollableAreaQt5` demo")
         window.resize(QSize(600, 200))
 
         scrollable_area = ScrollableAreaQt5()
 
         vbox = QVBoxLayout(scrollable_area.area)
-        label = QLabel(text='big window, small label')
+        label = QLabel(text="big window, small label")
         vbox.addWidget(label)
 
         window.setCentralWidget(scrollable_area)
         window.show()
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     app = QApplication([])
     examples = ExamplesScrollableAreaQt5()
     app.exec()

examples/examples_ScrollableAreaQt5.py

@@ -1,21 +1,20 @@
 #! /usr/bin/env python3
 
 import itertools
+
 from PyQt6.QtCore import QSize
 from PyQt6.QtWidgets import QApplication, QGridLayout, QLabel, QMainWindow, QVBoxLayout
-
 from ScrollableContainers import ScrollableAreaQt6
 
 
 class ExamplesScrollableAreaQt6:
-
     def __init__(self):
         self.grid_of_widgets(QMainWindow())
         self.single_widget(QMainWindow())
 
     def grid_of_widgets(self, window):
         self.win1 = window
-        window.setWindowTitle('`ScrollableAreaQt6` demo')
+        window.setWindowTitle("`ScrollableAreaQt6` demo")
 
         # Create a scrollable area.
         scrollable_area = ScrollableAreaQt6()
@@ -24,29 +23,29 @@ def grid_of_widgets(self, window):
         # the scrollable area itself.
         dim = 10
         grid_layout = QGridLayout(scrollable_area.area)
-        for (i, j) in itertools.product(range(dim), repeat=2):
-            label = QLabel(text=f'Label\n({i}, {j})')
+        for i, j in itertools.product(range(dim), repeat=2):
+            label = QLabel(text=f"Label\n({i}, {j})")
             grid_layout.addWidget(label, i, j)
 
         window.setCentralWidget(scrollable_area)
         window.show()
 
     def single_widget(self, window):
         self.win2 = window
-        window.setWindowTitle('`ScrollableAreaQt6` demo')
+        window.setWindowTitle("`ScrollableAreaQt6` demo")
         window.resize(QSize(600, 200))
 
         scrollable_area = ScrollableAreaQt6()
 
         vbox = QVBoxLayout(scrollable_area.area)
-        label = QLabel(text='big window, small label')
+        label = QLabel(text="big window, small label")
         vbox.addWidget(label)
 
         window.setCentralWidget(scrollable_area)
         window.show()
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     app = QApplication([])
     examples = ExamplesScrollableAreaQt6()
     app.exec()

examples/examples_ScrollableAreaQt6.py

@@ -2,44 +2,43 @@
 
 import itertools
 import tkinter as tk
-import tkinter.ttk as ttk
+from tkinter import ttk
 
 from ScrollableContainers import ScrollableFrameTk
 
 
 class ExamplesScrollableFrameTk:
-
     def __init__(self):
         self.grid_of_widgets(tk.Tk())
         self.single_widget(tk.Toplevel())
 
     def grid_of_widgets(self, window):
-        window.title('`ScrollableFrameTk` Demo')
+        window.title("`ScrollableFrameTk` Demo")
 
         # Create a scrollable frame.
         scrollable_frame = ScrollableFrameTk(window)
 
         # Add widgets to the `frame` attribute of the scrollable frame, not to
         # the scrollable frame itself.
         dim = 10
-        for (i, j) in itertools.product(range(dim), repeat=2):
-            label = ttk.Label(scrollable_frame.frame, text=f'Label\n({i}, {j})')
+        for i, j in itertools.product(range(dim), repeat=2):
+            label = ttk.Label(scrollable_frame.frame, text=f"Label\n({i}, {j})")
             label.grid(row=i, column=j, padx=10, pady=10)
 
         scrollable_frame.pack(expand=True, fill=tk.BOTH)
 
     def single_widget(self, window):
-        window.geometry('600x200+50+50')
-        window.title('`ScrollableFrameTk` Demo')
+        window.geometry("600x200+50+50")
+        window.title("`ScrollableFrameTk` Demo")
 
         scrollable_frame = ScrollableFrameTk(window)
 
-        label = ttk.Label(scrollable_frame.frame, text='big window, small label')
+        label = ttk.Label(scrollable_frame.frame, text="big window, small label")
         label.pack()
 
         scrollable_frame.pack(expand=True, fill=tk.BOTH)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     examples = ExamplesScrollableFrameTk()
     tk.mainloop()

examples/examples_ScrollableFrameTk.py

@@ -1,19 +1,18 @@
 #! /usr/bin/env python3
 
 import itertools
-import wx
 
+import wx
 from ScrollableContainers import ScrollablePanelWx
 
 
 class ExamplesScrollablePanelWx:
-
     def __init__(self):
         self.grid_of_widgets(wx.Frame(None))
         self.single_widget(wx.Frame(None))
 
     def grid_of_widgets(self, window):
-        window.SetTitle('`ScrollablePanelWx` Demo')
+        window.SetTitle("`ScrollablePanelWx` Demo")
 
         # Create a scrollable panel.
         scrollable_panel = ScrollablePanelWx(window)
@@ -22,27 +21,27 @@ def grid_of_widgets(self, window):
         # the scrollable panel itself.
         dim = 10
         grid_sizer = wx.GridSizer(dim, dim, 20, 20)
-        for (i, j) in itertools.product(range(dim), repeat=2):
-            text = wx.StaticText(scrollable_panel.panel, label=f'Label\n({i}, {j})')
+        for i, j in itertools.product(range(dim), repeat=2):
+            text = wx.StaticText(scrollable_panel.panel, label=f"Label\n({i}, {j})")
             grid_sizer.Add(text)
 
         scrollable_panel.panel.SetSizer(grid_sizer)
         scrollable_panel.SetupScrolling()
         window.Show()
 
     def single_widget(self, window):
-        window.SetTitle('`ScrollablePanelWx` Demo')
+        window.SetTitle("`ScrollablePanelWx` Demo")
         window.SetSize(600, 200)
 
         scrollable_panel = ScrollablePanelWx(window)
 
-        wx.StaticText(scrollable_panel.panel, label='big window, small label')
+        wx.StaticText(scrollable_panel.panel, label="big window, small label")
 
         scrollable_panel.SetupScrolling()
         window.Show()
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     app = wx.App()
     examples = ExamplesScrollablePanelWx()
     app.MainLoop()

examples/examples_ScrollablePanelWx.py

@@ -1,12 +1,12 @@
 [build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
 [project]
 name = "ScrollableContainers"
-version = "2.0.1"
+version = "2.0.1a0"
 authors = [
-    { name="Vishal Pankaj Chandratreya" },
+    { name = "Vishal Pankaj Chandratreya" },
 ]
 description = "Scrollable containers for Tkinter, wxPython, PyQt5 and PyQt6"
 readme = "README.md"
@@ -17,6 +17,22 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 
+[project.optional-dependencies]
+qt5 = ["PyQt5"]
+qt6 = ["PyQt6"]
+wx = ["wxPython"]
+
 [project.urls]
 "Homepage" = "https://github.com/tfpf/ScrollableContainers"
 "Bug Tracker" = "https://github.com/tfpf/ScrollableContainers/issues"
+
+[tool.hatch.envs.dev]
+features = [
+    "qt5",
+    "qt6",
+    "wx",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"src/ScrollableContainers/__init__.py" = ["F401", "N999"]
+"src/ScrollableContainers/_tk.py" = ["PLR2004"]