First round of updates (#10)

* start adding type hints and switch from os.path to pathlib.Path

* add pyproject.toml and poetry lock file

* Run isort and black

* Fixes for issues identified by ruff and pylance

* Finish fixes for ruff linting errors and a few small improvements.

* Updated utils.weight_stack

* small tweaks to avoid potentially unbound variables (thanks ruff)

* Switch github actions to use isort and ruff

* fix multi-line examples for doctest

* Cleanup actions to remove duplicate run of test suite

* remove setup.cfg and setup.py in favor of pyproject.toml

* Fixed test errors in test_cuda.py::TestReconCUDA

---------

Co-authored-by: Andrew Herzing <[email protected]>

.github/workflows/main.yml

@@ -5,19 +5,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - run: pip install flake8
-      - run: pip install pydocstyle
-      - run: flake8 --exclude=api.py --ignore=E501 etspy/
-      - if: always()
-        run: pydocstyle etspy/
+      - run: pip install ruff isort
+      - run: isort . --check
+      - run: ruff check
 
   pytest:
     runs-on: ubuntu-latest
     container:
       image: aaherzing/etspy:latest
     steps:
     - uses: actions/checkout@v4
-    - run: pip install -e ./
-    - run: pytest --doctest-modules --ignore=etspy/tests/test_datasets.py etspy/ 
-    - if: always()
-      run: pytest --ignore=etspy/tests/test_datasets.py etspy/tests/
+    - name: Install ETSpy
+      run: pip install -e ./
+    - name: Run docstring example tests
+      run: pytest --doctest-modules --ignore=etspy/tests etspy/ 
+    - name: Run full test suite
+      if: always()
+      run: pytest etspy/tests/

etspy/__init__.py

@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-#
-# This file is part of ETSpy
-"""__init__ function for ETSpy."""
+"""ETSpy."""
 
-__version__ = '0.8'
+__version__ = "0.8"