CreativePython 0.1.0__tar.gz → 0.1.2__tar.gz

creativepython-0.1.2/MANIFEST.in

@@ -0,0 +1,5 @@
+recursive-include src/CreativePython/resources *
+recursive-include src/CreativePython/examples *
+recursive-include src/CreativePython/scripts *
+recursive-exclude */.DS_Store
+recursive-exclude */__pycache__/*

creativepython-0.1.2/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: CreativePython
+Version: 0.1.2
+Summary: A Python-based software environment for developing algorithmic art projects.
+Author-email: "Dr. Bill Manaris" <manaris@cofc.edu>, Taj Ballinger <ballingertj@g.cofc.edu>, Trevor Ritchie <ritchiets@g.cofc.edu>
+License: MIT License
+        
+        Copyright (c) 2025 Dr. Bill Manaris
+        
+        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.
+        
+Project-URL: Homepage, https://jythonmusic.me
+Keywords: music,audio,midi,learning,algorithmic art,algoart
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tinysoundfont>=0.3.6
+Requires-Dist: osc4py3>=1.0.8
+Requires-Dist: mido>=1.3.3
+Requires-Dist: PySide6>=6.9.1
+Requires-Dist: sounddevice>=0.5.2
+Requires-Dist: soundfile>=0.13.1
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: pooch>=1.8
+Requires-Dist: pypianoroll>=1.0
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# CreativePython
+
+CreativePython is a Python-based software environment for learning and developing algorithmic art projects.  It mirrors the [JythonMusic API](https://jythonmusic.me/api-reference/), and is powered by [PySide6](https://wiki.qt.io/Qt_for_Python) and [portaudio](http://portaudio.com/).
+
+CreativePython is distributed under the MIT License.
+
+- [Homepage](https://jythonmusic.me/)
+- [Download All Examples [ZIP]](https://www.dropbox.com/scl/fo/rvc8m8pt4m0281qn0t4oi/AO2Y0W2qOrOcurlQmLa7M54?rlkey=0sf80bmov135tc85dk9k7ats6&dl=1)
+
+This package is still under development.
+
+# Beginner Installation (IDLE)
+
+1. Download and install the latest version of [Python](https://www.python.org/downloads/).
+
+2. Download the [CreativePython Setup Script](https://www.dropbox.com/scl/fi/253bvfqsf0ij3rmza88q5/_creativepythonSetup.py?rlkey=iu4y4u8pujltgfx6kbjmodu9m&dl=1).
+
+3. Open `creativePythonSetup.py` with IDLE, Python's Integrated Development Learning Environment.
+
+4. From the IDLE toolbar, select `Run`, then `Run Module`.
+
+5. CreativePython will check for its requirements on your system, download any missing requirements, and install its libraries.
+
+6. When you see `[CreativePython Setup]: CreativePython installed successfully.`, you're all done!  You're ready to start using CreativePython.
+
+**NOTE**: You can use the setup script in any Python3 environment - not just IDLE!
+
+# Custom Installation
+
+## Windows
+
+Install CreativePython using `pip`:
+
+```
+python -m pip install CreativePython
+```
+
+## MacOS
+
+Use [Homebrew](https://brew.sh/) to install the prerequisite [portaudio](http://portaudio.com/) library, then install CreativePython using `pip`:
+
+```
+brew install portaudio
+pip install CreativePython
+```
+
+## Linux
+
+Use apt, or your preferred package manager, to install the prerequisite [portaudio](http://portaudio.com/) library, then install CreativePython using `pip`:
+
+```
+sudo apt-get portaudio
+pip install CreativePython
+```
+
+# Using CreativePython
+
+## Importing Libraries
+
+CreativePython's core modules are the `music`, `gui`, `image`, `timer`, `osc`, and `midi` libraries.  You can import these libraries into your python code using:
+
+```
+import music
+from music import *
+from music import Note, Play, C4, HN
+```
+
+Or a similar statement.  CreativePython includes a number of useful constants, so we recommend using wildcard imports like `from music import *`.
+
+**NOTE**: The first time you import `music`, CreativePython will ask permission to download a high-quality soundfont (FluidR3 G2-2.sf2) for you.  You should only have to do this once.
+
+## Running CreativePython programs
+
+CreativePython is designed for use in Python's Interactive Mode.  To use Interactive Mode, enter a command like:
+
+```
+python -i <filename>.py
+```
+
+## Example
+
+Download [playNote.py](https://www.dropbox.com/scl/fi/z6rkjy4xnofmg0t899se3/playNote.py?rlkey=o3t8c91ne6agj2lqf2aupl8m5&dl=1):
+
+```
+# playNote.py
+# Demonstrates how to play a single note.
+ 
+from music import *        # import music library
+ 
+note = Note(C4, HN)        # create a middle C half note
+Play.midi(note)            # and play it!
+```
+
+In a terminal, run the code in interactive mode:
+
+```
+python -i playNote.py
+```
+
+If this is the first time you've used CreativePython, it will ask to download a soundfont.
+
+After you do, you should hear a single C4 half-note.

creativepython-0.1.2/README.md

@@ -0,0 +1,102 @@
+# CreativePython
+
+CreativePython is a Python-based software environment for learning and developing algorithmic art projects.  It mirrors the [JythonMusic API](https://jythonmusic.me/api-reference/), and is powered by [PySide6](https://wiki.qt.io/Qt_for_Python) and [portaudio](http://portaudio.com/).
+
+CreativePython is distributed under the MIT License.
+
+- [Homepage](https://jythonmusic.me/)
+- [Download All Examples [ZIP]](https://www.dropbox.com/scl/fo/rvc8m8pt4m0281qn0t4oi/AO2Y0W2qOrOcurlQmLa7M54?rlkey=0sf80bmov135tc85dk9k7ats6&dl=1)
+
+This package is still under development.
+
+# Beginner Installation (IDLE)
+
+1. Download and install the latest version of [Python](https://www.python.org/downloads/).
+
+2. Download the [CreativePython Setup Script](https://www.dropbox.com/scl/fi/253bvfqsf0ij3rmza88q5/_creativepythonSetup.py?rlkey=iu4y4u8pujltgfx6kbjmodu9m&dl=1).
+
+3. Open `creativePythonSetup.py` with IDLE, Python's Integrated Development Learning Environment.
+
+4. From the IDLE toolbar, select `Run`, then `Run Module`.
+
+5. CreativePython will check for its requirements on your system, download any missing requirements, and install its libraries.
+
+6. When you see `[CreativePython Setup]: CreativePython installed successfully.`, you're all done!  You're ready to start using CreativePython.
+
+**NOTE**: You can use the setup script in any Python3 environment - not just IDLE!
+
+# Custom Installation
+
+## Windows
+
+Install CreativePython using `pip`:
+
+```
+python -m pip install CreativePython
+```
+
+## MacOS
+
+Use [Homebrew](https://brew.sh/) to install the prerequisite [portaudio](http://portaudio.com/) library, then install CreativePython using `pip`:
+
+```
+brew install portaudio
+pip install CreativePython
+```
+
+## Linux
+
+Use apt, or your preferred package manager, to install the prerequisite [portaudio](http://portaudio.com/) library, then install CreativePython using `pip`:
+
+```
+sudo apt-get portaudio
+pip install CreativePython
+```
+
+# Using CreativePython
+
+## Importing Libraries
+
+CreativePython's core modules are the `music`, `gui`, `image`, `timer`, `osc`, and `midi` libraries.  You can import these libraries into your python code using:
+
+```
+import music
+from music import *
+from music import Note, Play, C4, HN
+```
+
+Or a similar statement.  CreativePython includes a number of useful constants, so we recommend using wildcard imports like `from music import *`.
+
+**NOTE**: The first time you import `music`, CreativePython will ask permission to download a high-quality soundfont (FluidR3 G2-2.sf2) for you.  You should only have to do this once.
+
+## Running CreativePython programs
+
+CreativePython is designed for use in Python's Interactive Mode.  To use Interactive Mode, enter a command like:
+
+```
+python -i <filename>.py
+```
+
+## Example
+
+Download [playNote.py](https://www.dropbox.com/scl/fi/z6rkjy4xnofmg0t899se3/playNote.py?rlkey=o3t8c91ne6agj2lqf2aupl8m5&dl=1):
+
+```
+# playNote.py
+# Demonstrates how to play a single note.
+ 
+from music import *        # import music library
+ 
+note = Note(C4, HN)        # create a middle C half note
+Play.midi(note)            # and play it!
+```
+
+In a terminal, run the code in interactive mode:
+
+```
+python -i playNote.py
+```
+
+If this is the first time you've used CreativePython, it will ask to download a soundfont.
+
+After you do, you should hear a single C4 half-note.

{creativepython-0.1.0 → creativepython-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "CreativePython"
-version = "0.1.0"
+version = "0.1.2"
 description = "A Python-based software environment for developing algorithmic art projects."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -24,23 +24,27 @@ dependencies = [
    "tinysoundfont>=0.3.6",
    "osc4py3>=1.0.8",
    "mido>=1.3.3",
-   "numpy>=2.3.2",
-   "pyaudio>=0.2.14",
    "PySide6>=6.9.1",
    "sounddevice>=0.5.2",
    "soundfile>=0.13.1",
    "tqdm>=4.67.1",
    "pooch>=1.8",
-   "platformdirs>=4.2",
    "pypianoroll>=1.0"
 ]
 
 [project.urls]
 Homepage = "https://jythonmusic.me"
 
-[project.scripts]
-cp-setup = "creativepython_setup:run"
-cp-test = "creativepython_setup:playNote"
+[tool.setuptools.package-data]
+CreativePython = [
+   "examples/*",
+   "scripts/*",
+   "resources/*",
+   # "bin/windows/*",
+   # "bin/macos/*",
+   # "licenses/*",
+   # "wheels/*.whl"
+]
 
 [project.optional-dependencies]
 dev = ["build", "twine"]

creativepython-0.1.2/src/CreativePython/_creativepythonSetup.py

@@ -0,0 +1,134 @@
+# creativePythonSetup.py
+# This script installs CreativePython, and any missing system requirements
+# MacOS: Portaudio (installed via Homebrew)
+# Win64: None
+# Linux: None
+
+import os, platform, shutil, subprocess
+import sys, pathlib
+
+debug = True
+LOG_PATH = str(pathlib.Path.home() / "Desktop" / "creativepython-install.log")
+
+class SetupError(Exception):
+   pass
+
+def _print(text):
+   print(f"[CreativePython Setup]: {text}")
+
+def _run(cmd, env=os.environ, log=None, check=True):
+   if debug: _print(f"Running: {' '.join(cmd)}")
+   result = subprocess.run(
+      cmd,
+      check=False,
+      text=True,
+      stdout=subprocess.PIPE,
+      stderr=subprocess.PIPE,
+      env=env
+   )
+
+   if log:
+      log.write(f"\n$ {' '.join(cmd)}\n")
+      if result.stdout: log.write(result.stdout)
+      if result.stderr: log.write(f"\n[stderr]\n{result.stderr}")
+   if check and result.returncode != 0:
+      raise SetupError(f"Command failed: {' '.join(cmd)} (exit {result.returncode})")
+   
+   return result
+
+
+def _findHomebrew():
+   if debug: _print("Looking for Homebrew...")
+   brew = shutil.which("brew")  # check if brew is on PATH
+
+   if not brew:
+      if debug: _print("Didn't find Homebrew, checking other locations...")
+      # brew not on PATH, so check common install locations
+      commonBins = ["/opt/homebrew/bin/brew", "/usr/local/bin/brew"]
+      i = 0
+      while not brew and i < len(commonBins):
+         if os.path.exists(commonBins[i]):  # bin is installed, so add it to PATH
+            os.environ["PATH"] = commonBins[i] + os.pathsep + os.environ.get("PATH", "")
+            brew = commonBins[i]
+         i = i + 1
+
+   if debug:
+      if brew: _print(f"Homebrew found at {brew}")
+      else: _print("Failed to find Homebrew...")
+
+   return brew
+
+
+def _installHomebrew():
+   if debug: _print("Installing Homebrew...")
+   env = dict(os.environ)
+   env["NONINTERACTIVE"] = "1"
+
+   _run('/bin/bash', '-c', '"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"', env=env)  # install homebrew
+
+   brew = _findHomebrew()  # and verify installation   
+   if not brew:
+      raise SetupError("Homebrew installation failed.  Ensure you have internet access and try again.")
+   
+   if debug: _print("Homebrew installed successfully.")
+   return brew
+
+
+def _isBrewPackageInstalled(package, brew=None):
+   if debug: _print(f"Looking for {package}...")
+   if not brew: brew = _findHomebrew()
+
+   isInstalled = subprocess.run(
+      [brew, "list", "--versions", package],
+      stdout=subprocess.DEVNULL,
+      stderr=subprocess.DEVNULL
+   ).returncode == 0
+
+   if debug:
+      if isInstalled: _print(f"{package} found.")
+      else: _print(f"Failed to find {package}...")
+
+   return isInstalled
+
+
+def _installBrewPackage(package, brew=None):
+   if debug: _print(f"Installing {package}...")
+   if not brew: brew = _findHomebrew()
+
+   _run([brew, 'update'])            # update Homebrew...
+   _run([brew, 'install', package])  # ... and install package
+
+   if not _isBrewPackageInstalled(package):   # verify installation
+      raise SetupError(f"{package} installation failed.  Ensure you have internet access and try again.")
+   
+   if debug: _print(f"{package} installed successfully.")
+
+
+def _installCreativePython():
+   if debug: _print(f"Installing CreativePython... (log: {LOG_PATH})")
+
+   with open(LOG_PATH, "w", encoding="utf-8", errors="replace") as log:
+      # find the python interpreter location
+      py = sys.executable.replace("pythonw.exe", "python.exe")
+
+      _run([py, '-m', 'pip', 'install', '--upgrade', 'pip', 'setuptools', 'wheel'], log=log, check=False)
+      _run([py, '-m', 'pip', 'install', '--user', 'CreativePython'], log=log)
+
+   if debug: _print("CreativePython installed successfully.")
+
+   import music  # import music to trigger soundfont download
+
+
+
+if __name__ == "__main__":
+   
+   if platform.system() == "Darwin":                # check for MacOS...
+      brew = _findHomebrew()
+      if not brew:                                  # ... check for Homebrew...
+         brew = _installHomebrew()                  # ... no, so install it
+
+      if not _isBrewPackageInstalled("portaudio", brew):  # next, check for portaudio ...
+         _installBrewPackage("portaudio", brew)           # ... no, so install it
+
+   # now, requirements have been met
+   _installCreativePython()

creativepython-0.1.2/src/CreativePython/_soundfont.py

@@ -0,0 +1,72 @@
+from pathlib import Path
+from platformdirs import user_data_dir
+from pooch import retrieve
+import os
+
+APP = "CreativePython"
+ORG = "CofC"
+
+SOUNDFONT_NAME = "default.sf2"
+CACHE_DIR = Path(user_data_dir(APP, ORG)) / "SoundFonts"
+SOUNDFONT_PATH = CACHE_DIR / SOUNDFONT_NAME
+
+SF2_URL = "https://www.dropbox.com/s/xixtvox70lna6m2/FluidR3%20GM2-2.SF2?dl=1"
+SF2_SHA256 = "2ae766ab5c5deb6f7fffacd6316ec9f3699998cce821df3163e7b10a78a64066"
+
+##### SOUNDFONTS #####
+
+def _findSoundfont(candidate=None):
+   """
+   Finds a soundfont 'default.sf2' and returns its location.
+   'candidate' can be another path containing the soundfont.
+   """
+   candidates = []
+   soundfontPath = None
+
+   # path as argument?
+   if candidate:
+      candidates.append(Path(candidate))
+   
+   # path as environment variable?
+   env = os.getenv("CREATIVEPYTHON_SOUNDFONT")
+   if env:
+      candidates.append(Path(env))
+
+   # default soundfont location
+   candidates+= [SOUNDFONT_PATH, Path.home() / "SoundFonts" / SOUNDFONT_NAME]
+
+   # find first valid candidate
+   i = 0
+   while soundfontPath is None and i < len(candidates):
+      c = candidates[i]
+      if c and c.exists():
+         soundfontPath = str(c)
+
+   return soundfontPath
+
+
+def _downloadSoundfont(destination=SOUNDFONT_PATH):
+   """
+   Downloads FluidR3 GM2-2 to given destination as 'default.sf2'
+   """
+   # create parent directory
+   destination.parent.mkdir(parents=True, exist_ok=True)
+   # download soundfont
+   path = retrieve(
+      url=SF2_URL,
+      known_hash=f"sha256:{SF2_SHA256}",
+      progressbar=True,
+      fname=destination.name,
+      path=str(destination.parent)
+   )
+   return path
+
+
+def _installSoundfont():
+   soundfontPath = _findSoundfont()
+   if not soundfontPath:
+      print(f"[CreativePython Setup]: Downloading MIDI Soundfont...")
+      _soundfontPath = _downloadSoundfont()
+      print(f"[CreativePython Setup]: Soundfont downloaded to {_soundfontPath}")
+
+   return _soundfontPath

creativepython-0.1.2/src/CreativePython/examples/ArvoPart.CantusInMemoriam.py

@@ -0,0 +1,76 @@
+# ArvoPart.CantusInMemoriam.py
+#
+# Recreates a variation of Arvo Part's "Cantus in Memoriam Benjamin
+# Britten" (1977) for string orchestra and bell, using Mod functions.
+ 
+from music import *
+ 
+# musical parameters
+repetitions = 2   # length of piece
+tempo = 112       # tempo of piece
+bar = WN+HN       # length of a measure
+ 
+# create musical data structure
+cantusScore = Score("Cantus in Memoriam Benjamin Britten", tempo)
+ 
+bellPart = Part(TUBULAR_BELLS, 0)
+violinPart = Part(VIOLIN, 1)
+ 
+# bell
+bellPitches   = [REST,  A4,    REST, REST,  A4,    REST, REST,  A4]
+bellDurations = [bar/2, bar/2, bar,  bar/2, bar/2, bar,  bar/2, bar/2]
+ 
+bellPhrase = Phrase(0.0)
+bellPhrase.addNoteList(bellPitches, bellDurations)
+bellPart.addPhrase(bellPhrase)
+ 
+# violin - define descending aeolian scale and rhythms
+pitches   = [A5, G5, F5,  E5,  D5,  C5,  B4,  A4]
+durations = [HN, QN, HN, QN, HN, QN, HN, QN]
+ 
+# violin 1
+violin1Phrase = Phrase(bar * 6.5)  # start after 6 and 1/2 measures
+violin1Phrase.addNoteList(pitches, durations)
+ 
+# violin 2
+violin2Phrase = violin1Phrase.copy()
+violin2Phrase.setStartTime(bar * 7.0)  # start after 7 measures
+Mod.elongate(violin2Phrase, 2.0)       # double durations
+Mod.transpose(violin2Phrase, -12)      # an octave lower
+ 
+# violin 3
+violin3Phrase = violin2Phrase.copy()
+violin3Phrase.setStartTime(bar * 8.0)  # start after 8 measures
+Mod.elongate(violin3Phrase, 2.0)       # double durations
+Mod.transpose(violin3Phrase, -12)      # an octave lower
+ 
+# violin 4
+violin4Phrase = violin3Phrase.copy()
+violin4Phrase.setStartTime(bar * 10.0) # start after 10 measures
+Mod.elongate(violin4Phrase, 2.0)       # double durations
+Mod.transpose(violin4Phrase, -12)      # an octave lower
+ 
+# repeat phrases enough times
+Mod.repeat(violin1Phrase, 8 * repetitions)
+Mod.repeat(violin2Phrase, 4 * repetitions)
+Mod.repeat(violin3Phrase, 2 * repetitions)
+Mod.repeat(violin4Phrase, repetitions)
+ 
+# violin part
+violinPart.addPhrase(violin1Phrase)
+violinPart.addPhrase(violin2Phrase)
+violinPart.addPhrase(violin3Phrase)
+violinPart.addPhrase(violin4Phrase)
+ 
+# score
+cantusScore.addPart(bellPart)
+cantusScore.addPart(violinPart)
+ 
+# fade in, and fade out
+Mod.fadeIn(cantusScore, WN)
+Mod.fadeOut(cantusScore, WN * 12)
+ 
+# view, play, and write
+View.sketch(cantusScore)
+Play.midi(cantusScore)
+Write.midi (cantusScore, "ArvoPart.CantusInMemoriam.mid")

creativepython-0.1.2/src/CreativePython/examples/ConcretPH_Xenakis.py

@@ -0,0 +1,41 @@
+# ConcretPH_Xenakis.py
+#
+# A short example which generates a random cloud texture
+# inspired by Iannis Xenakis's 'Concret PH' composition
+#
+# see http://en.wikipedia.org/wiki/Concret_PH
+ 
+from music import *
+from random import *
+ 
+# constants for controlling musical parameters
+cloudWidth = 64          # length of piece (in quarter notes)
+cloudDensity = 23.44     # how dense the cloud may be
+particleDuration = 0.2   # how long each sound particle may be
+numParticles = int(cloudDensity * cloudWidth)   # how many particles
+ 
+part = Part(BREATHNOISE)
+ 
+# make particles (notes) and add them to cloud (part)
+for i in range(numParticles):
+ 
+   # create note with random attributes
+   pitch = randint(0, 127)     # pick from 0 to 127
+   duration = random() * particleDuration # 0 to particleDuration
+   dynamic = randint(0, 127)   # pick from silent to loud
+   panning = random()          # pick from left to right
+   note = Note(pitch, duration, dynamic, panning)   # create note
+ 
+   # now, place it somewhere in the cloud (time continuum)
+   startTime = random() * cloudWidth    # pick from 0 to end of piece
+   phrase = Phrase(startTime)           # create phrase with this start time
+   phrase.addNote(note)                 # add the above note
+   part.addPhrase(phrase)               # and add both to the part
+# now, all notes have been created
+ 
+# add some elegance to the end
+Mod.fadeOut(part, 20)
+ 
+View.show(part)
+Play.midi(part)
+Write.midi(part, "ConcretPh.mid")