add ReadtheDocs config; officially support python3.13

.github/workflows/main.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        python-version: ["3.7", "3.9", "3.12"]
+        python-version: ["3.7", "3.9", "3.11", "3.13"]
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}

.gitignore

@@ -1,12 +1,14 @@
 # temp files
+__pycache__/
 *.swp
-*.pyc
+*.py[cod]
 .cache
 
-# setuptools related
-dist/*
-build/*
-.eggs/*
+# packaging related
+dist/
+build/
+eggs/
+.eggs/
 SigMF.egg-info/*
 
 # test related
@@ -16,3 +18,6 @@ SigMF.egg-info/*
 coverage.xml
 pytest.xml
 htmlcov/*
+
+# docs related
+docs/_build/

.readthedocs.yaml

@@ -0,0 +1,26 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - test
+        - apps
+    - requirements: docs/requirements.txt
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx==7.1.2
+sphinx-rtd-theme==1.3.0rc1

docs/source/api.rst

@@ -0,0 +1,7 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+
+   sigmf

docs/source/conf.py

@@ -0,0 +1,53 @@
+# Copyright: Multiple Authors
+#
+# This file is part of sigmf-python. https://github.com/sigmf/sigmf-python
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+"""Configuration file for the Sphinx documentation builder."""
+
+import datetime
+import re
+from pathlib import Path
+
+# parse info from project files
+
+root = Path(__file__).parent.parent.parent
+with open(root / "sigmf" / "__init__.py", "r") as handle:
+    init = handle.read()
+    toolversion = re.search(r'__version__\s*=\s*[\'"]([^\'"]*)[\'"]', init).group(1)
+    specversion = re.search(r'__specification__\s*=\s*[\'"]([^\'"]*)[\'"]', init).group(1)
+print("DBUG", toolversion, specversion)
+
+# -- Project information
+
+project = "sigmf"
+author = "Multiple Authors"
+copyright = f"2017-{datetime.date.today().year}, {author}"
+
+release = toolversion
+version = toolversion
+
+# -- General configuration
+
+extensions = [
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
+}
+intersphinx_disabled_domains = ["std"]
+
+templates_path = ["_templates"]
+
+# -- Options for HTML output
+
+html_theme = "sphinx_rtd_theme"
+
+# -- Options for EPUB output
+epub_show_urls = "footnote"

docs/source/index.rst

@@ -0,0 +1,20 @@
+Welcome to SigMF!
+=================
+
+**sigmf** is a Python library for working with radio recordings as specified in the `SigMF <https://sigmf.org/>`_ standard.
+It offers a *simple* and *intuitive* API for python developers.
+
+Check out the :doc:`usage` section for further information, including
+how to :ref:`installation` the project.
+
+.. note::
+
+   This project is under active development.
+
+Contents
+--------
+
+.. toctree::
+
+   usage
+   api

docs/source/usage.rst

@@ -0,0 +1,69 @@
+Usage
+=====
+
+.. _installation:
+
+Installation
+------------
+
+To install the latest PyPi release, install from pip:
+
+.. code-block:: console
+
+   $ pip install sigmf
+
+To install the latest git release, build from source:
+
+.. code-block:: console
+
+   $ git clone https://github.com/sigmf/sigmf-python.git
+   $ cd sigmf-python
+   $ pip install .
+
+Testing
+-------
+
+Testing can be run locally:
+
+.. code-block:: console
+
+   $ coverage run
+
+Run coverage on multiple python versions:
+
+.. code-block:: console
+
+   $ tox run
+
+Other tools developers may want to use:
+
+.. code-block:: console
+
+   $ pytest -rA tests/test_archive.py # test one file verbosely
+   $ pylint sigmf tests # lint entire project
+   $ black sigmf tests # autoformat entire project
+   $ isort sigmf tests # format imports for entire project
+
+Examples
+--------
+
+Load a SigMF archive; read all samples & metadata
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+   import sigmf
+   handle = sigmf.sigmffile.fromfile("example.sigmf")
+   handle.read_samples() # returns all timeseries data
+   handle.get_global_info() # returns 'global' dictionary
+   handle.get_captures() # returns list of 'captures' dictionaries
+   handle.get_annotations() # returns list of all annotations
+
+Verify SigMF dataset integrity & compliance
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: console
+
+   $ sigmf_validate example.sigmf
+
+TODO: Insert more examples from `README.md`.

pyproject.toml

@@ -7,12 +7,12 @@ classifiers = [
     "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.7",
     "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",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Scientific/Engineering",
     "Topic :: Communications :: Ham Radio",
 ]