Installable Python package with pyproject.toml

.github/workflows/main.yml

@@ -17,18 +17,26 @@ jobs:
             app_file_ext: "app"
             asset_file_ext: "zip"
     runs-on: ${{ matrix.os }}-latest
+    defaults:
+      run:
+        shell: bash -l {0}
     steps:
     - uses: actions/checkout@v3
 
     - name: Activate Anaconda Environment
       uses: conda-incubator/setup-miniconda@v2
       with:
-        environment-file: environments/${{ matrix.os }}-environment.yml
-        python-version: 3.11
+        miniconda-version: latest
+        activate-environment: tactool
         auto-activate-base: false
 
+    - name: Build Environment
+      run: |
+        conda create -n tactool python=3.13
+        conda activate tactool
+        pip install -e ".[pyinstaller]"
+
     - name: Build with PyInstaller
-      shell: bash -l {0}
       run: pyinstaller --name="tactool" --windowed --paths=. --onefile tactool/main.py
 
     - name: ZIP Application

.github/workflows/test.yml

@@ -4,7 +4,7 @@ on:
   push:
     paths:
       - '**.py'
-      - 'environments/*.yml'
+      - 'pyproject.toml'
       - '.github/workflows/test.yml'
 
 jobs:
@@ -13,22 +13,29 @@ jobs:
       matrix:
         os: [windows, macos]
     runs-on: ${{ matrix.os }}-latest
+    defaults:
+      run:
+        shell: bash -l {0}
     steps:
     - uses: actions/checkout@v3
 
     - name: Activate Anaconda Environment
       uses: conda-incubator/setup-miniconda@v2
       with:
-        environment-file: environments/${{ matrix.os }}-environment.yml
-        python-version: 3.11
+        miniconda-version: latest
+        activate-environment: tactool
         auto-activate-base: false
 
+    - name: Build Environment
+      run: |
+        conda create -n tactool python=3.13
+        conda activate tactool
+        pip install -e ".[test]"
+
     - name: Lint
-      shell: bash -l {0}
       run: flake8
 
     - name: Test
-      shell: bash -l {0}
       run: |
         export PYTHONPATH=.
         pytest -vvs test/

.gitignore

@@ -4,3 +4,19 @@ dist
 .pytest_cache
 _LOCAL_LEO
 *.spec
+*.swp
+*.pyc
+.tox
+.ipynb_checkpoints/
+*.egg-info
+htmlcov
+coverage.xml
+.coverage*
+.vscode
+pip-wheel-metadata
+*Thumbs.db
+*.DS_Store
+*.idea
+.mypy_cache/
+junit.xml
+.vscode-server

README.md

@@ -38,44 +38,28 @@ The original idea was by Connor Newstead and Matt Horstwood.
 
 If you would like to give feedback, ask questions, submit a bug report, or make a contribution to TACtool, you are welcome to submit an issue to the repository [here](https://github.com/BritishGeologicalSurvey/tactool/issues).
 
-### Installation
+### Developer Installation
 
 > Note: this is only if you want to run the tool from the source code. If you just want to use the app, see "[Getting started](#getting-started)" above.
 
-Check out the repository and install dependencies using Anaconda.
+Clone the repository, create a virtual environment, e.g. with `conda`, and activate it.
+Then install the package with `pip` in editable mode for development with the optional
+dependencies for testing.
 
-#### Windows
-```bash
-conda env create -f environments/windows-environment.yml
-conda activate tactool-windows
 ```
-
-#### MacOS
-```bash
-conda env create -f environments/macos-environment.yml
-conda activate tactool-macos
+conda create -n tactool python=3.14
+conda activate tactool
+cd tactool
+python3 -m pip install -e ".[test]"
 ```
 
-_Note: Both environments have been generated using `environments/unversioned-environment.yml`._
-
 ### Running the Program
 
-To run the program, first you need to setup your Python path.
+To run the program, activate the environment and run the `tactool --dev` command.
 
-#### Windows
-```bash
-$env:PYTHONPATH="."
 ```
-
-#### MacOS
-```bash
-export PYTHONPATH=.
-```
-
-Then you can run the program with:
-
-```bash
-python tactool/main.py --dev
+conda activate tactool
+tactool --dev
 ```
 
 The `--dev` flag starts the application in developer mode, with a test image

pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["tactool"]
+
+[project]
+name = "tactool"
+description = "TACtool: A targeting and co-ordination tool for spatial sampling and data traceability applied to scanning electron microscopy and laser ablation ICP-MS"
+version = "1.3.1"
+license = "GPL-3.0-only"
+license-files = ["LICENSE"]
+keywords = ["targeting", "co-ordination", "spatial", "traceability", "scanning", "electron", "microscopy", "sem", "laser", "ablation", "icp-ms", "gui"]
+requires-python = ">=3.11"
+dynamic = ["readme"]
+dependencies = [
+    "numpy",
+    "pyqt5",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+authors = [
+    {name="Leo Rudczenko", email="leorud@bgs.ac.uk"},
+    {name="John Stevenson", email="jostev@bgs.ac.uk"},
+    {name="Connor Newstead", email="connor.newstead@npl.co.uk"},
+    {name="Matthew Horstwood", email="msah@bgs.ac.uk"},
+]
+
+[project.urls]
+repository = "https://github.com/BritishGeologicalSurvey/tactool/"
+
+[project.optional-dependencies]
+test = ["pytest", "flake8"]
+pyinstaller = ["pyinstaller"]
+
+[project.scripts]
+tactool = "tactool.main:main"
+
+[tool.setuptools.dynamic]
+readme = {file = ["README.md"], content-type="text/markdown"}

tactool/main.py

@@ -88,7 +88,7 @@ def recoordinate_dialog(self) -> RecoordinateDialog:
         return self.window.recoordinate_dialog
 
 
-if __name__ == "__main__":
+def main() -> TACtool:
     parser = argparse.ArgumentParser(description="Application for annotating images with analysis points.")
     parser.add_argument(
         "--dev",
@@ -105,3 +105,8 @@ def recoordinate_dialog(self) -> RecoordinateDialog:
     args = parser.parse_args()
 
     tactool_application = TACtool(sys.argv, developer_mode=args.dev, debug_mode=args.debug)
+    return tactool_application
+
+
+if __name__ == "__main__":
+    main()