Testing (#3)

* Write tests for openning a file

* Update open to warn if the file is incomplete

* Now closing the file if there is an error opening it

* Add a test to open valid files

* Shrink test file

* Write tests for the header

* Write tests for get sweep n

* Write tests for get_all_sweeps and dunder methods

* Write a test for files with no sweeps

* Write tests for the sweeps

* Write visualization tests

* Reformat the files

* Add version file

* Getting things ready for publishing

* Create github workflow

* Fix syntax error

* Fix another error

* Add pytest install...

* Testing the CI/CD

* Confirmed that CI/CD will fail if a test fails

* Update documentation

Author: tomschmitz98

.github/workflows/unittest.yml

@@ -0,0 +1,26 @@
+name: Testing
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+permissions:
+  contents: read
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Python 3.10 setup
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+          pip install pytest
+
+      - name: Unit testing
+        run: |
+          pytest -v

.gitignore

@@ -1,5 +1,4 @@
 .idea/
-*.shr
 build/
 py_shr_parser.egg-info
 __pycache__/

Documentation/appendix.rst

@@ -2,6 +2,15 @@
 Appendix
 ========
 
+Related Software
+================
+* shr-parser_: A Rust library for parsing SHR files.
+* shr-parser-py_: Another Python package for parsing SHR files written in Rust. This project is no longer
+  maintained at the time of writing.
+
+.. _shr-parser: https://github.com/Xerrion/shr_parser
+.. _shr-parser-py: https://pypi.org/project/shr-parser/
+
 License
 =======
 Copyright (c) 2025, WiSELab-CMU

Documentation/pyshrparser.rst

@@ -34,12 +34,12 @@ This installs a package that can be used from Python (``import shr_parser``).
 To install for all users on the system, administrator
 rights (root) may be required.
 
-From PyPI (Not published yet. This doesn't work yet)
+From PyPI
 ----------------------------------------------------
 pyshrparser can be installed from PyPI::
 
-    pip install pyshrparser
-    python3 -m pip install pyshrparser
+    pip install py-shr-parser
+    python3 -m pip install py-shr-parser
 
 Developers also may be interested to get the source archive, because it
 contains examples, tests and this documentation.

README.rst

@@ -15,16 +15,25 @@ Documentation
 -------------
 For API documentation, usage and examples, see the files in the "Documentation" directory. 
 The ".rst" files can be read in any text editor or being converted to HTML or PDF
-using Sphinx.
+using Sphinx_. Examples can be found in the documentation and tests.
 
-Examples
---------
-Examples do not exist yet...
+.. _Sphinx: https://www.sphinx-doc.org/en/master/
 
 Installation
 ------------
-Eventually will be published on PyPl. Currently download the repo and run
 
 .. code-block:: none
 
-    pip install <path to root of this repo>
+    pip install py-shr-parser
+
+Basic Example
+-------------
+This shows how to open an SHR file and load all the sweep data.
+
+.. code-block:: python
+
+    from shr_parser import ShrFileParser
+    with ShrFileParser("foo.shr") as parser:
+        sweeps = parser.get_all_sweeps()
+
+The above example is very basic. For more advanced examples, please refer to the Documentation.

pyproject.toml

@@ -3,21 +3,36 @@ requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools.packages.find]
-where = ["."]
+where = ["src"]
 
 [project]
 name = "py-shr-parser"
-version = "0.0.0"
+version = "1.0.0"
 authors = [
     { name = "Tom Schmitz", email="tschmitz@andrew.cmu.edu" },
 ]
 description = "Python library for parsing Signal Hound SHR files"
 requires-python = ">=3.8"
 classifiers = [
+    "Development Status :: 5 - Production/Stable",
     "Programming Language :: Python :: 3",
-    "Operating System :: OS Independent"
+    "Operating System :: OS Independent",
 ]
 dependencies = [
     "numpy",
     "matplotlib",
 ]
+license = "BSD-3-Clause"
+keywords = ["SHR", "Signal Hound",]
+readme = "README.rst"
+
+[project.urls]
+Homepage = "https://github.com/WiseLabCMU/py-shr-parser"
+"Bug Tracker" = "https://github.com/WiseLabCMU/py-shr-parser/issues"
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "-ra -q"
+testpaths = [
+    "tests",
+]

shr_parser/__init__.py src/shr_parser/__init__.pyshr_parser/__init__.py renamed to src/shr_parser/__init__.py

@@ -1,4 +1,5 @@
 from .shr_parser import ShrSweep, ShrFileParser
 from .enumerations import ShrScale, ShrWindow, ShrDecimationDetector, ShrVideoDetector, ShrVideoUnits, ShrDecimationType, ShrChannelizerOutputUnits
-from .exceptions import ShrFileParserException, FileNotOpenError
+from .exceptions import ShrFileParserException, FileNotOpenError, ShrFileParserWarning
 from .metadata import ShrSweepHeader, ShrFileHeader
+from .version import __version__

shr_parser/enumerations.py src/shr_parser/enumerations.pyshr_parser/enumerations.py renamed to src/shr_parser/enumerations.py

@@ -8,3 +8,8 @@ class FileNotOpenError(ShrFileParserException):
 
     def __init__(self):
         super().__init__("File not open")
+
+
+class ShrFileParserWarning(RuntimeWarning):
+    """Warning indicating that further parsing may result in an error"""
+    pass