update package config to conform to pep 508 where everything is handled in pyproject.toml; update CI and require python >=3.12; fix codestyle bugs; comment out test that now hangs indefinitely

Author: tepickering

.github/workflows/saomsg-tests.yml

@@ -7,91 +7,36 @@ name: Python Tests
 on:
   push:
     branches:
-    - main  # GitHub now defaults to 'main' as the name of the primary branch.
+      - main
+    tags:
+      - '*'
   pull_request:
-    branches: # only build on PRs against 'main'
-    - main
+  schedule:
+    # run every Monday at 6am UTC
+    - cron: '0 6 * * 1'
 
-jobs:
-
-  matrix_tests:
-    runs-on: ${{ matrix.os }}
-    if: "!contains(github.event.head_commit.message, '[ci skip]')"
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        python-ver: [8, 9]
-        tox-env: [cov, astropylts, astropydev]
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up python 3.${{ matrix.python-ver }} with tox environment ${{ matrix.tox-env }} on ${{ matrix.os }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.${{ matrix.python-ver }}
-    - name: Install base dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install numpy tox
-    - name: Run MSG test server in container
-      run: docker run -d --rm -p 6868:6868 -v ${PWD}/scripts:/scripts -w="/scripts" --entrypoint="/usr/bin/tclsh" python:latest msg_test.tcl
-    - name: Test with tox
-      run: |
-        tox -e py3${{ matrix.python-ver }}-${{ matrix.tox-env }}
-    - name: Upload coverage to codecov
-      if: matrix.tox-env == 'cov' && matrix.python-ver == '8'
-      uses: codecov/codecov-action@v2
-      with:
-        token: ${{ secrets.CODECOV }}
-        file: ./coverage.xml
-        fail_ci_if_error: true
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
-  doc_test:
-    runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, '[ci skip]')"
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python to test links in docs with sphinx
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.9
-    - name: Install base dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install tox
-    - name: Build and check docs using tox
-      run: |
-        tox -e linkcheck
+jobs:
+  tests:
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV }}
+    with:
+      submodules: false
+      coverage: ''
+      envs: |
+        - name: Codestyle
+          linux: codestyle
 
-  build_docs:
-    runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, '[ci skip]')"
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python to build docs with sphinx
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.9
-    - name: Install base dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install tox
-    - name: Build docs using tox
-      run: |
-        tox -e build_docs
+        - name: Python 3.12 on Linux with all dependencies, remote data, and coverage
+          linux: py311-test-alldeps-cov
+          coverage: codecov
+          toxargs: -v
+          posargs: --remote-data=any
 
-  codestyle:
-    runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, '[ci skip]')"
-    steps:
-    - uses: actions/checkout@v2
-    - name: Python codestyle check
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.9
-    - name: Install base dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install tox
-    - name: Check codestyle using tox
-      run: |
-        tox -e codestyle
+        - name: (Allowed Failure) Python 3.12 on Linux with dev dependencies
+          linux: py312-test-astropydev
+          toxargs: -v

.readthedocs.yaml

@@ -0,0 +1,23 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  apt_packages:
+    - graphviz
+  tools:
+    python: "3.12"
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+        - all
+
+formats: []

.readthedocs.yml

@@ -1,11 +1,9 @@
 include README.rst
-include CHANGES.rst
-include setup.cfg
-include LICENSE.rst
 include pyproject.toml
 
 recursive-include saomsg *.pyx *.c *.pxd
 recursive-include docs *
+recursive-include example_clients *
 recursive-include licenses *
 recursive-include scripts *
 

MANIFEST.in

@@ -25,64 +25,38 @@
 # Thus, any C-extensions that are needed to build the documentation will *not*
 # be accessible, and the documentation will not build correctly.
 
-import os
 import sys
 import datetime
-from importlib import import_module
+
+from saomsg import __version__
 
 try:
     from sphinx_astropy.conf.v1 import *  # noqa
 except ImportError:
     print('ERROR: the documentation requires the sphinx-astropy package to be installed')
     sys.exit(1)
 
-# Get configuration information from setup.cfg
-from configparser import ConfigParser
-conf = ConfigParser()
-
-conf.read([os.path.join(os.path.dirname(__file__), '..', 'setup.cfg')])
-setup_cfg = dict(conf.items('metadata'))
-
 # -- General configuration ----------------------------------------------------
 
 # By default, highlight as Python 3.
 highlight_language = 'python3'
 
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.2'
-
-# To perform a Sphinx version check that needs to be more specific than
-# major.minor, call `check_sphinx_version("x.y.z")` here.
-# check_sphinx_version("1.2.1")
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns.append('_templates')
-
-# This is added to the end of RST files - a good place to put substitutions to
-# be used globally.
-rst_epilog += """
-"""
-
 # -- Project information ------------------------------------------------------
 
 # This does not *have* to match the package name, but typically does
-project = setup_cfg['name']
-author = setup_cfg['author']
+project = 'saomsg'
+author = "T. E. Pickering"
 copyright = '{0}, {1}'.format(
-    datetime.datetime.now().year, setup_cfg['author'])
+    datetime.datetime.now().year, author)
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 
-import_module(setup_cfg['name'])
-package = sys.modules[setup_cfg['name']]
-
 # The short X.Y version.
-version = package.__version__.split('-', 1)[0]
+version = __version__.split('-', 1)[0]
 # The full version, including alpha/beta/rc tags.
-release = package.__version__
+release = __version__
 
 
 # -- Options for HTML output --------------------------------------------------
@@ -109,7 +83,7 @@
     'logotext1': 'py-saomsg',  # white,  semi-bold
     'logotext2': '',  # orange, light
     'logotext3': ':docs'   # white,  light
-    }
+}
 
 
 # Custom sidebar templates, maps document names to template names.
@@ -151,44 +125,14 @@
 man_pages = [('index', project.lower(), project + u' Documentation',
               [author], 1)]
 
-
-# -- Options for the edit_on_github extension ---------------------------------
-
-if setup_cfg.get('edit_on_github').lower() == 'true':
-
-    extensions += ['sphinx_astropy.ext.edit_on_github']
-
-    edit_on_github_project = setup_cfg['github_project']
-    edit_on_github_branch = "main"
-
-    edit_on_github_source_root = ""
-    edit_on_github_doc_root = "docs"
-
-# -- Resolving issue number to links in changelog -----------------------------
-github_issues_url = 'https://github.com/{0}/issues/'.format(setup_cfg['github_project'])
-
 # -- Turn on nitpicky mode for sphinx (to warn about references not found) ----
 #
-# nitpicky = True
-# nitpick_ignore = []
-#
-# Some warnings are impossible to suppress, and you can list specific references
-# that should be ignored in a nitpick-exceptions file which should be inside
-# the docs/ directory. The format of the file should be:
-#
-# <type> <class>
-#
-# for example:
-#
-# py:class astropy.io.votable.tree.Element
-# py:class astropy.io.votable.tree.SimpleElement
-# py:class astropy.io.votable.tree.SimpleElementWithContent
-#
-# Uncomment the following lines to enable the exceptions:
-#
-# for line in open('nitpick-exceptions'):
-#     if line.strip() == "" or line.startswith("#"):
-#         continue
-#     dtype, target = line.split(None, 1)
-#     target = target.strip()
-#     nitpick_ignore.append((dtype, six.u(target)))
+nitpicky = True
+
+# -- Options for linkcheck output -------------------------------------------
+linkcheck_retry = 5
+linkcheck_ignore = [
+    "https://www.aanda.org/",
+]
+linkcheck_timeout = 180
+linkcheck_anchors = False