Merge PR #134: Prepare ThinkDSP for PyPI packaging

Author: AllenDowney

.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Build sdist and wheel
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build
+          python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/thinkdsp-kim
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -1 +1,25 @@
 .ipynb_checkpoints/
+.DS_Store
+
+# Python
+__pycache__/
+*.py[cod]
+*.pyd
+.python-version
+*.egg-info/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+
+# Packaging/build
+build/
+dist/
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+# Poetry
+poetry.lock

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 Allen B. Downey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -8,6 +8,13 @@
 
 [Read *Think DSP* in HTML](http://greenteapress.com/thinkdsp/html/index.html).
 
+## Attribution
+
+This repository packages the `thinkdsp` code from *Think DSP* by Allen B. Downey.
+Original code and copyright remain with the author under the MIT License.
+This packaging fork is maintained by `hoppa1231` and is not affiliated with the
+original author or publisher.
+
 The premise of this book (and the other books in the Think X series) is that if you know how to program, you can use that skill to learn other things. I am writing this book because I think the conventional approach to digital signal processing is backward: most books (and the classes that use them) present the material bottom-up, starting with mathematical abstractions like phasors.
 
 With a programming-based approach, I can go top-down, which means I can present the most important ideas right away. By the end of the first chapter, you can decompose a sound into its harmonics, modify the harmonics, and generate new sounds.

nb/thinkdsp.py

@@ -23,9 +23,7 @@
 try:
     from IPython.display import Audio
 except ImportError:
-    warnings.warn(
-        "Can't import Audio from IPython.display; " "Wave.make_audio() will not work."
-    )
+    Audio = None
 
 PI2 = np.pi * 2
 
@@ -73,7 +71,7 @@ def write(self, wave):
         wave: Wave
         """
         zs = wave.quantize(self.bound, self.dtype)
-        self.fp.writeframes(zs.tostring())
+        self.fp.writeframes(zs.tobytes())
 
     def close(self, duration=0):
         """Closes the file.
@@ -112,7 +110,7 @@ def read_wave(filename="sound.wav"):
         xs = np.fromstring(z_str, dtype=np.int8).astype(np.int32)
         ys = (xs[2::3] * 256 + xs[1::3]) * 256 + xs[0::3]
     else:
-        ys = np.fromstring(z_str, dtype=dtype_map[sampwidth])
+        ys = np.frombuffer(z_str, dtype=dtype_map[sampwidth])
 
     # if it's in stereo, just pull out the first channel
     if nchannels == 2:
@@ -1087,6 +1085,11 @@ def play(self, filename="sound.wav"):
 
     def make_audio(self):
         """Makes an IPython Audio object."""
+        if Audio is None:
+            raise ImportError(
+                "IPython is required for Wave.make_audio(). "
+                "Install with `pip install ipython`."
+            )
         audio = Audio(data=self.ys.real, rate=self.framerate)
         return audio
 

pyproject.toml

@@ -1,20 +1,39 @@
 [tool.poetry]
-name = "thinkdsp"
-version = "0.1.0"
-description = ""
+name = "thinkdsp-kim"
+version = "0.1.1"
+description = "DSP utilities from the Think DSP book"
 authors = ["Allen Downey <allen.downey@olin.edu>"]
+maintainers = ["Kim Maxim <maksimkim005@gmail.com>"]
+readme = "README.md"
+license = "MIT"
+packages = [{ include = "thinkdsp", from = "src" }]
+include = ["LICENSE"]
+exclude = ["book", "code", ".devcontainer", ".github"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Education",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Multimedia :: Sound/Audio :: Analysis",
+    "Topic :: Scientific/Engineering :: Mathematics",
+]
 
 [tool.poetry.dependencies]
-python = "^3.8"
-jupyter = "^1.0.0"
-numpy = "^1.19.4"
-matplotlib = "^3.3.3"
-seaborn = "^0.11.0"
-pandas = "^1.1.4"
-scipy = "^1.5.4"
+python = ">=3.9,<4.0"
+numpy = ">=1.22.4,<3.0"
+scipy = ">=1.13.0,<2.0"
+matplotlib = ">=3.8.0,<4.0"
+jupyter = { version = "^1.0.0", optional = true }
+pandas = { version = "^1.1.4", optional = true }
+seaborn = { version = "^0.11.0", optional = true }
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.extras]
+notebooks = ["jupyter", "pandas", "seaborn"]
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.0"
 
 [build-system]
-requires = ["poetry>=0.12"]
-build-backend = "poetry.masonry.api"
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

requirements-dev.txt

@@ -1,5 +1,7 @@
 -r requirements.txt
 black
+nb_black==1.0.5
 flake8
+nbformat
 nbmake
 pytest