Maintenance

Status reports and other tools to have the checks all in one place, for quick QC.

Quick overview / QC

All possible badges of the CI chain. Definitely check this before making a release.

  • GitHub Actions linux GitHub Actions macos & windows GitHub Actions linkcheck Documentation Status

    Ensure CI and docs are passing.

  • PyPI conda-forge

    Ensure latest version is deployed on PyPI and conda.

  • Coveralls Codacy

    Check CI coverage and code quality is good.

  • Airspeed Velocity

    Check Benchmarks are run up to the latest version.

  • Zenodo DOI

    Check Zenodo is linking to the latest release.

Info from ReadTheDocs

To check the environment in which the documentation was built.

In [1]: import empymod
   ...: empymod.Report(
   ...:     ['sphinx', 'numpydoc', 'sphinx_panels', 'sphinx_numfig',
   ...:      'sphinx_gallery', 'memory_profiler', 'pydata_sphinx_theme',
   ...:      'sphinx_automodapi', 'ipykernel', ]
   ...: )
   ...: 
Out[1]: 

--------------------------------------------------------------------------------
  Date: Sun Jul 04 10:59:58 2021 UTC

                 OS : Linux
             CPU(s) : 2
            Machine : x86_64
       Architecture : 64bit
                RAM : 3.6 GiB
        Environment : IPython

  Python 3.8.6 (default, Oct 19 2020, 15:10:29)  [GCC 7.5.0]

             sphinx : 4.0.2
           numpydoc : 1.1.0
      sphinx_panels : 0.6.0
      sphinx_numfig : 0.1.0
     sphinx_gallery : 0.9.0
    memory_profiler : 0.58.0
pydata_sphinx_theme : 0.6.3
  sphinx_automodapi : 0.13
          ipykernel : 6.0.1
              numpy : 1.21.0
              scipy : 1.7.0
              numba : 0.53.1
            empymod : 2.1.2
            IPython : 7.25.0
         matplotlib : 3.4.2
--------------------------------------------------------------------------------