Release 0.9.5 work, more python3 and documentation updates.

(cherry picked from commit 04efa1edc9dba40fd20af3e36db023ed53ec7847)

Author: weegreenblobbie

Diff for: .github/workflows/linux.yml renamed to .github/workflows/linux.yaml

@@ -2,9 +2,13 @@ name: linux
 
 on:
   push:
-    branches: [ master ]
+    branches:
+    - master
+    - 'release/**'
   pull_request:
-    branches: [ master ]
+    branches:
+    - master
+    - 'release/**'
 
 jobs:
   build:
@@ -19,7 +23,7 @@ jobs:
         sudo apt-get update && sudo apt-get -y install portaudio19-dev libao-dev python3-virtualenv
         python3 -m venv venv
         . venv/bin/activate
-        pip install matplotlib scons
+        pip install matplotlib scons wheel
     - name: Build nsound
       run: |
         . venv/bin/activate
@@ -31,4 +35,4 @@ jobs:
     - name: Run python tests
       run: |
         . venv/bin/activate
-        scons --disable-libportaudio --pytest
+        scons --pytest --disable-libportaudio --config=force

Diff for: .github/workflows/macos.yml renamed to .github/workflows/macos.yaml

@@ -2,9 +2,13 @@ name: macos
 
 on:
   push:
-    branches: [ master ]
+    branches:
+    - master
+    - 'release/**'
   pull_request:
-    branches: [ master ]
+    branches:
+    - master
+    - 'release/**'
 
 jobs:
 
@@ -19,7 +23,7 @@ jobs:
       name: Install Python
     - name: Install dependencies
       run: |
-        pip3 install matplotlib scons
+        pip3 install matplotlib scons wheel
     - name: Build nsound
       run: |
         scons

Diff for: .github/workflows/windows.yaml

@@ -2,9 +2,13 @@ name: windows
 
 on:
   push:
-    branches: [ master ]
+    branches:
+    - master
+    - 'release/**'
   pull_request:
-    branches: [ master ]
+    branches:
+    - master
+    - 'release/**'
 
 jobs:
 
@@ -19,7 +23,7 @@ jobs:
       name: Install Python
     - name: Install dependencies
       run: |
-        pip3 install matplotlib scons 
+        pip3 install matplotlib scons wheel
     - name: Build nsound
       run: |
         scons

Diff for: ChangeLog

@@ -13,6 +13,14 @@ Key:
 + Finished item
 - Planned item
 
+2021-12-30 Nsound 0.9.5
+    + Lots of updates for building and linking with Python3
+    + Added github Actions to build on Linux, MacOs and Windows
+    + Added FilterMedian
+    + Updated Plotter to use latest matplotlib.pyplot
+    + Added an Intersteller inspired example: src/examples/interstellar.cc
+
+
 2015-08-23 Nsound 0.9.4
 
     + C++11 now required for compiling Nsound

Diff for: README.rst

@@ -1,36 +1,36 @@
-.. image:: https://github.com/weegreenblobbie/nsound/workflows/linux/badge.svg
-   :target: https://github.com/weegreenblobbie/nsound/actions?query=workflow%3Alinux
+.. image:: https://github.com/weegreenblobbie/nsound/actions/workflows/linux.yaml/badge.svg?branch=release/0.9.5
+   :target: https://github.com/weegreenblobbie/nsound/actions/workflows/linux.yaml?query=workflow%3Alinux+branch%3Arelease%2F0.9.5
    :alt: Github Actions
 
-.. image:: https://github.com/weegreenblobbie/nsound/workflows/macos/badge.svg
-   :target: https://github.com/weegreenblobbie/nsound/actions?query=workflow%3Amacos
+.. image:: https://github.com/weegreenblobbie/nsound/actions/workflows/macos.yaml/badge.svg?branch=release/0.9.5
+   :target: https://github.com/weegreenblobbie/nsound/actions/workflows/macos.yaml?query=workflow%3Amacos+branch%3Arelease%2F0.9.5
    :alt: Github Actions
 
-.. image:: https://github.com/weegreenblobbie/nsound/workflows/windows/badge.svg
-   :target: https://github.com/weegreenblobbie/nsound/actions?query=workflow%3Awindows
+.. image:: https://github.com/weegreenblobbie/nsound/actions/workflows/windows.yaml/badge.svg?query=branch:release/0.9.5
+   :target: https://github.com/weegreenblobbie/nsound/actions/workflows/windows.yaml?query=workflow:windows+branch:release/0.9.5
    :alt: Github Actions
 
 Nsound, a C++ framework for synthesizing sound
 ==============================================
 
 .. hyper link references
 
-.. _`Nsound Homepage`: http://nsound.sourceforge.net/
-.. _`Nsound User's Guide`: http://nsound.sourceforge.net/users_guide/
-.. _`Nsound Doxygen Reference`: http://nsound.sourceforge.net/doxygen/index.html
+.. _`Nsound Homepage`: https://github.com/weegreenblobbie/nsound
+.. _`Nsound User's Guide`: https://weegreenblobbie.com/nsound/user_guide/index.html
+.. _`Nsound Doxygen Reference`: https://weegreenblobbie.com/nsound/doxygen/index.html
 
 .. _`Introduction & Bebot`: https://www.youtube.com/watch?v=j4uLvl68PtI
-.. _`bebot.py`: http://sourceforge.net/p/nsound/code/HEAD/tree/branch/nsound-dev-weegreenblobbie/src/examples/bebot.py
+.. _`bebot.py`: https://github.com/weegreenblobbie/nsound/blob/master/src/examples/bebot.py
 
 .. _`Oscilloscope`: https://www.youtube.com/watch?v=ORnQVFpdSoA
-.. _`make_oscilloscope_video.py`:  http://sourceforge.net/p/nsound/code/HEAD/tree/branch/nsound-dev-weegreenblobbie/src/examples/make_oscilloscope_video.py
+.. _`make_oscilloscope_video.py`:  https://github.com/weegreenblobbie/nsound/blob/master/src/examples/make_oscilloscope_video.py
 
 .. _`Moog VCF & Delayline`: https://www.youtube.com/watch?v=9m3KA6JBDH8
-.. _`moogvcf-rt.py`: http://sourceforge.net/p/nsound/code/HEAD/tree/branch/nsound-dev-weegreenblobbie/src/examples/moogvcf-rt.py
-.. _`delayline-rt.py`: http://sourceforge.net/p/nsound/code/HEAD/tree/branch/nsound-dev-weegreenblobbie/src/examples/delayline-rt.py
+.. _`moogvcf-rt.py`: https://github.com/weegreenblobbie/nsound/blob/master/src/examples/moogvcf-rt.py
+.. _`delayline-rt.py`: https://github.com/weegreenblobbie/nsound/blob/master/src/examples/delayline-rt.py
 
 .. _`Tape Deck`: https://www.youtube.com/watch?v=Al6aHlwyEuA
-.. _`tapedeck-rt.py`: http://sourceforge.net/p/nsound/code/HEAD/tree/branch/nsound-dev-weegreenblobbie/src/examples/tapedeck-rt.py
+.. _`tapedeck-rt.py`: https://github.com/weegreenblobbie/nsound/blob/master/src/examples/tapedeck-rt.py
 
 
 Important Links
@@ -59,5 +59,5 @@ If you're on Windows, OS X, or Linux:
 
 .. code-block:: bash
 
-    pip install nsound --user
+    python3 -m pip install Nsound
 

Diff for: SConstruct

@@ -40,12 +40,12 @@ VERSION_A = "0"
 VERSION_B = "9"
 VERSION_C = "5"
 
-DEVELOPMENMT = True
+DEVELOPMENMT = False
 
 PACKAGE_VERSION = "%s.%s.%s" % (VERSION_A, VERSION_B, VERSION_C)
 
 if DEVELOPMENMT:
-    PACKAGE_VERSION += ".dev1"
+    PACKAGE_VERSION += ".dev10"
 
 PACKAGE_RELEASE = PACKAGE_NAME + "-" + PACKAGE_VERSION
 
@@ -184,11 +184,14 @@ if GetOption("pytest"):
     commands = [
         ["scons", "-c"],
         build_cmd,
-        ["python", "setup_builder.py", "install"],
+        ["python", "setup_builder.py", "bdist_wheel"],
+        ["python", "-m", "pip", "install", "--isolated", "--ignore-installed", "dist/*"],
         ["python", "-m", "unittest", "discover"],
     ]
 
     for cmd in commands:
+        if cmd[-1] == "dist/*":
+            cmd[-1] = glob.glob("dist/*")[0]
         print("    " + str(cmd))
         subprocess.check_call(cmd)
 
@@ -549,15 +552,17 @@ if not nsound_config.env.GetOption("help"):
     #--------------------------------------------------------------------------
     # Extra Cleaning
 
+    nsound_config.env.Clean(libNsound, "Nsound.egg-info")
     nsound_config.env.Clean(libNsound, "Nsound.py")
-    nsound_config.env.Clean(libNsound, "swig/Nsound.py")
+    nsound_config.env.Clean(libNsound, "__pycache__")
     nsound_config.env.Clean(libNsound, "bin")
     nsound_config.env.Clean(libNsound, "build")
     nsound_config.env.Clean(libNsound, "dist")
     nsound_config.env.Clean(libNsound, "docs/user_guide/build/doctrees")
     nsound_config.env.Clean(libNsound, "docs/user_guide/build/html")
     nsound_config.env.Clean(libNsound, "docs/user_guide/build/plot_directive")
     nsound_config.env.Clean(libNsound, "lib")
+    nsound_config.env.Clean(libNsound, "swig/Nsound.py")
     nsound_config.env.Clean(libNsound, "swig/nsound_wrap.cxx")
     nsound_config.env.Clean(libNsound, "swig/nsound_wrap.os")
     nsound_config.env.Clean(libNsound, doxyfile)
@@ -570,8 +575,8 @@ if not nsound_config.env.GetOption("help"):
     nsound_config.env.Clean(libNsound, glob.glob("src/examples/Temperature_out.wav"))
     nsound_config.env.Clean(libNsound, glob.glob("src/examples/example*.wav"))
     nsound_config.env.Clean(libNsound, glob.glob("src/examples/mynameis-*.wav"))
-    nsound_config.env.Clean(libNsound, glob.glob("src/test/*.wav"))
     nsound_config.env.Clean(libNsound, glob.glob("src/test/*.obj"))
+    nsound_config.env.Clean(libNsound, glob.glob("src/test/*.wav"))
     nsound_config.env.Clean(libNsound, nsound_h)
     nsound_config.env.Clean(libNsound, setup_builder_py)
     nsound_config.env.Clean(libNsound, unit_tests)
@@ -598,51 +603,4 @@ if not nsound_config.env.GetOption("help"):
 
     nsound_config.env.Alias("install", [nsound_config.env['NS_BINDIR'], nsound_config.env['NS_LIBDIR']])
 
-    #--------------------------------------------------------------------------
-    # Setup Tar and Zip
-
-    EXCLUDE_EXTENSIONS = [
-#~        ".a",  need to include mingw32 libs
-        ".cache",
-        ".cvsignore",
-        ".dblite",
-        ".dll",
-        ".gz",
-        ".jpg",
-        ".log",
-        ".mp3",
-        ".o",
-        ".os",
-        ".png",
-        ".pyc",
-        ".so",
-        ".tar",
-        ".tmp",
-        ".zip",
-        "core",
-        "~"
-        ]
-
-    EXCLUDE_DIRS = [
-        ".svn",
-        ".sconf_temp",
-        "./bin",
-        "./lib",
-        "./docs/user_guide/build",
-        "./msw"
-        ]
-
-    if 'release' in COMMAND_LINE_TARGETS:
-        if(use_disttar):
-            nsound_config.env['DISTTAR_FORMAT']='gz'
-
-            nsound_config.env.Append(\
-                DISTTAR_EXCLUDE_EXTS = EXCLUDE_EXTENSIONS,
-                DISTTAR_EXCLUDE_DIRS = EXCLUDE_DIRS)
-
-            tar = env.DistTar(PACKAGE_RELEASE + ".tar.gz", [nsound_config.env.Dir(".")])
-
-            nsound_config.env.Alias("release", tar)
-
-
 # :mode=python:

Diff for: docs/reference/Doxyfile.in

@@ -1085,6 +1085,7 @@ PDF_HYPERLINKS         = NO
 # higher quality PDF documentation.
 
 USE_PDFLATEX           = NO
+USE_MATHJAX            = YES
 
 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
 # command to the generated LaTeX files. This will instruct LaTeX to keep

Diff for: docs/user_guide/sphinxext/__init__.py renamed to docs/user_guide/my/__init__.py

@@ -0,0 +1,72 @@
+"""
+$Id: pyexec_directive.py 589 2010-12-18 11:13:05Z weegreenblobbie $
+
+This Sphinx extentsion allows one to inline python code and have it execute,
+the results of the code snippit should be stored in a string with the name
+template.
+
+For example, to embed the current date and time, to the following.
+
+.. pyexec::
+
+    from datetime import datetime
+    template = "%s" % datetime.now()
+
+Larger strings can be made using Python's tripple quote syntax.
+
+.. pyexec::
+
+    frome datetime import datetime
+
+    template = '''
+    This text will get inserted into the document at the pyexec directive
+    above.  Inline code can all be used::
+
+        print("I love Python, the current time is %s"''' % datetime.now())
+
+"""
+import sys
+
+from docutils.parsers.rst import Directive
+
+class PyExec(Directive):
+
+    has_content = True
+    required_arguments = 0
+    optional_arguments = 0
+
+    def run(self):
+
+        py_code = "\n".join(self.content)
+
+        globals_ = globals()
+        locals_ = locals()
+
+        try:
+            exec(py_code, globals_, locals_)
+            template = locals_['template']
+
+        except Exception as e:
+            message = f"""
+
+ERROR: An exception occured during the evaluation of the pyexec directive
+
+The offending code was:
+
+{py_code}
+
+"""
+            sys.stderr.write(message)
+            sys.stderr.flush()
+            raise
+
+        lines = ["%s" % row.rstrip() for row in template.split('\n')]
+        self.state_machine.insert_input(
+            lines, self.state_machine.input_lines.source(0))
+
+        return []
+
+
+def setup(app):
+    app.add_directive('pyexec', PyExec, True)
+