Skip to content

Commit 73e0913

Browse files
committed
chore: update docs and packaging after removing CLI/webapp scripts
## CHANGES - update README to remove `./generate` and `./webapp` usage - change all CLI/webapp instructions to use `binaural-generate` and `binaural-webapp` - remove mentions of deleted `generate` and `webapp` files from documentation - bump package version from 0.6.3 to 0.6.4 - delete `generate` and `webapp` executable script wrappers - set `package = true` in `[tool.uv]` config in `pyproject.toml` - change `binaural-generator` source in lockfile to `{ editable = "." }`
1 parent c275316 commit 73e0913

File tree

6 files changed

+9
-48
lines changed

6 files changed

+9
-48
lines changed

README.md

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -168,18 +168,12 @@ pip install binaural-generator
168168
169169
For a more interactive experience, run the web-based user interface:
170170
171-
If you installed the Python package (via `pip install`), simply run:
171+
Once you installed the Python package (via `pip install` or from source), simply run:
172172
173173
```bash
174174
binaural-webapp
175175
```
176176
177-
If running from the repository source directory:
178-
179-
```bash
180-
./webapp
181-
```
182-
183177
This launches a Streamlit-based web interface that allows you to:
184178
185179
- Create and edit audio sequences through a visual interface
@@ -192,18 +186,12 @@ Once launched, open your web browser and navigate to `http://localhost:8501` to
192186
193187
### Command Line Interface
194188
195-
Similarly, to run the CLI script if you installed the Python package:
189+
Similarly, to run the CLI script:
196190
197191
```bash
198192
binaural-generate [options] <path_to_script.yaml>
199193
```
200194
201-
From the source directory:
202-
203-
```bash
204-
./generate [options] <path_to_script.yaml>
205-
```
206-
207195
**Arguments:**
208196
209197
- `<path_to_script.yaml>`: YAML file defining the binaural beat sequence and settings.
@@ -219,23 +207,23 @@ From the source directory:
219207
To use the example script provided (which defaults to FLAC output):
220208
221209
```bash
222-
./generate example_script.yaml
210+
binaural-generate example_script.yaml
223211
```
224212
225213
This will generate `audio/example_fade_noise.flac` (or the filename specified in `example_script.yaml`) in the `audio/` directory.
226214
227215
To use one of the pre-defined scripts from the library and output as WAV:
228216
229217
```bash
230-
./generate scripts/relaxation_alpha.yaml -o audio/relaxation_alpha.wav
218+
binaural-generate scripts/relaxation_alpha.yaml -o audio/relaxation_alpha.wav
231219
```
232220
233221
This will generate `relaxation_alpha.wav` in the `audio/` directory, overriding the default name in the script.
234222
235223
To generate a FLAC file with a custom name:
236224
237225
```bash
238-
./generate scripts/focus_beta.yaml -o my_focus_session.flac
226+
binaural-generate scripts/focus_beta.yaml -o my_focus_session.flac
239227
```
240228
241229
You can also reference the builtin scripts without using the full path. Simply list the
@@ -411,7 +399,7 @@ Example usage for WAV output with added noise (assuming you modify the script):
411399

412400
```bash
413401
# (First, edit binaural_generator/scripts/sleep_delta.yaml to add background_noise section)
414-
./generate binaural_generator/scripts/sleep_delta.yaml -o audio/sleep_delta_with_noise.wav
402+
binaural-generate binaural_generator/scripts/sleep_delta.yaml -o audio/sleep_delta_with_noise.wav
415403
```
416404

417405
## File Structure
@@ -473,7 +461,6 @@ binaural_generator
473461
conftest.py: Pytest configuration file with custom markers and command-line options.
474462
cspell.json: Configuration for code spell-checking with custom dictionary of specialized terms.
475463
example_script.yaml: Example YAML configuration demonstrating various binaural beat features.
476-
generate: Executable script wrapper for the command-line interface with env path correction.
477464
LICENSE: MIT license file with copyright information and terms of use.
478465
pyproject.toml: Project configuration with dependencies, scripts, and development tools settings.
479466
README.md: Project documentation with detailed usage instructions and background information.
@@ -492,7 +479,6 @@ tests
492479
└── test_utils.py: Tests for configuration loading and utility functions.
493480
494481
uv.lock: Dependency lock file for the uv package manager with exact versions.
495-
webapp: Executable script wrapper for the web interface with env path correction.
496482
497483
```
498484

binaural_generator/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
"Version information for binaural_generator package."
22

3-
__version__ = "0.6.3"
3+
__version__ = "0.6.4"

generate

Lines changed: 0 additions & 13 deletions
This file was deleted.

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ python_files = "test_*.py"
6969

7070
[tool.uv]
7171
required-version = ">=0.6.11"
72+
package = true
7273

7374
[tool.pylint.MASTER]
7475
ignore = ["__init__.py", ".git", ".venv", "__pycache__"]

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

webapp

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)