refactor: rename src to sysaudio & Standardize Build System#7
Merged
Conversation
Include explicit instructions for editable install using `uv` to ensure proper `sysaudio` package resolution for notebooks and scripts.
…ew tools * Architecture: Renamed `src/` reference to `sysaudio/` and expanded library documentation to include `experiments`, `io`, and `plots`. * Scripts: Added documentation for `master_transfer.py`, `stream.py`, and visualization tools (`joyplot`, `playback_scope`). Introduced `fun/` directory. * Notebooks: Updated descriptions for notebooks 03 (Transfer Acquisition) and 04 (Analysis) to match current implementation status. * Quick Start: Revised installation and execution steps to run from project root using editable install (`-e .`).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR refactors the internal Python package from
srctosysaudioto resolve naming conflicts and establishes a standard build system usingsetuptools. It also fixes the CI pipeline by ensuring the package is installed in editable mode (pip install -e .) before running tests and notebooks, preventingModuleNotFoundErrorin the test runner.Changes
📦 Package & Build
oscilloscope-rp2040/src/→oscilloscope-rp2040/sysaudio/.[build-system]topyproject.tomland configuredtool.setuptools.packages.findto correctly locate the nested package..github/workflows/ci.ymlto explicitly install the local package (uv pip install -e .) so thatnbmakeandpytestcan importsysaudio.*.egg-info/to.gitignore.🛠 Scripts & Notebooks
sys.pathmodification boilerplate from all scripts (e.g.,record.py) in favor of standard imports.from src import ...statements tofrom sysaudio import ....01through04to match the new package name.📚 Documentation
uv pip install -e .workflow.sysaudio, added documentation for new tools (master_transfer.py,fun/,joyplot), and clarified the usage of scripts vs. notebooks.Impact
This change ensures that both local development (using
uv) and CI environments (GitHub Actions) use the same robust installation method, eliminating path hacks and ensuring consistent test results.