Changes to prepare for packaging and deployment

Author: vshekar

.gitignore

@@ -159,4 +159,6 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 .vscode/
-.DS_Store
+.DS_Store
+
+_version.py

lix.py

@@ -20,7 +20,7 @@
     QWidget,
 )
 
-from microscope.microscope import Microscope
+from qmicroscope.microscope import Microscope
 
 
 class Form(QMainWindow):

main.py

@@ -19,10 +19,10 @@
     QWidget,
 )
 
-from microscope.microscope import Microscope
-from microscope.container import Container
-from microscope.settings import Settings
-from microscope.plugins.record_plugin import RecordPlugin
+from qmicroscope.microscope import Microscope
+from qmicroscope.container import Container
+from qmicroscope.settings import Settings
+from qmicroscope.plugins.record_plugin import RecordPlugin
 
 
 class Form(QMainWindow):

monitor.py

@@ -16,17 +16,18 @@
     QWidget,
     QSplitter,
 )
-from microscope.microscope import Microscope
-from microscope.container import Container
-from microscope.settings import Settings
-from microscope.plugins import (
+from qmicroscope.microscope import Microscope
+from qmicroscope.container import Container
+from qmicroscope.settings import Settings
+from qmicroscope.plugins import (
     ZoomPlugin,
     GridPlugin,
     PresetPlugin,
     ScalePlugin,
     TogglePlugin,
     CrossHairPlugin,
     RecordPlugin,
+    SquareGridPlugin,
 )
 
 
@@ -47,6 +48,7 @@ def __init__(self, parent=None):
             PresetPlugin,
             ScalePlugin,
             RecordPlugin,
+            SquareGridPlugin,
         ]
         self.main_microscope = Microscope(self, viewport=False, plugins=plugins)
         self.main_microscope.scale = [0, 500]

pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "qmicroscope"
+description = "A camera widget for qt GUIs using qtpy"
+readme = "README.md"
+authors = [
+    { name = "Venkateswaran (Shekar) Shekar", email = "[email protected]" },
+]
+requires-python = ">=3.8"
+
+dependencies = ["qtpy", "opencv-python", "Pillow"]
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Physics",
+]
+dynamic = ["version"]
+
+[tool.hatch]
+version.source = "vcs"
+build.hooks.vcs.version-file = "qmicroscope/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["qmicroscope"]

microscope/__init__.py qmicroscope/__init__.pymicroscope/__init__.py renamed to qmicroscope/__init__.py

@@ -1,7 +1,7 @@
 from qtpy.QtWidgets import QWidget, QGridLayout
 from qtpy.QtGui import QPaintEvent
 from qtpy.QtCore import QSettings
-from microscope.microscope import Microscope
+from qmicroscope.microscope import Microscope
 from typing import List
 
 """ A widget that contains one or more microscope widgets in a grid. """

microscope/container.py qmicroscope/container.pymicroscope/container.py renamed to qmicroscope/container.py

@@ -8,7 +8,7 @@
     QGroupBox,
 )
 from typing import Dict, Optional
-from microscope.plugins.base_plugin import BasePlugin
+from qmicroscope.plugins.base_plugin import BasePlugin
 
 
 class PluginSettingsDialog(QDialog):