omniforge/notebooklm-py-analysis
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

docs: sync documentation with E2E fixture redesign

Browse source 
- Update adding-rpc-methods.md example to use read_only_notebook_id
- Add fixture selection guidance comments in E2E test example
- Fix hardcoded ~/.notebooklm paths to reference NOTEBOOKLM_HOME

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Teng Lin 2026-01-08 16:32:37 -05:00
parent 597d7ce2fb
commit 155c9743e9
3 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.env.example
View file

@ -11,7 +11,7 @@
# Inline authentication JSON for CI/CD (optional)
# When set, authentication is read from this variable instead of a file
# Get the value from: cat ~/.notebooklm/storage_state.json
# Get the value from: cat $NOTEBOOKLM_HOME/storage_state.json (default: ~/.notebooklm)
# NOTEBOOKLM_AUTH_JSON='{"cookies":[...]}'
# Enable RPC debug logging (optional)
@ -31,5 +31,5 @@ NOTEBOOKLM_READ_ONLY_NOTEBOOK_ID=your-notebook-id-here
# Optional: Generation test notebook ID
# If not set, a notebook will be auto-created and its ID stored in
# ~/.notebooklm/generation_notebook_id for reuse across test runs.
# NOTEBOOKLM_HOME/generation_notebook_id for reuse across test runs.
# NOTEBOOKLM_GENERATION_NOTEBOOK_ID=your-generation-notebook-id

8
docs/contributing/adding-rpc-methods.md
View file

@ -257,9 +257,13 @@ async def test_new_feature(mock_client):
```python
@pytest.mark.e2e
@pytest.mark.asyncio
async def test_new_feature_e2e(client, test_notebook_id):
async def test_new_feature_e2e(client, read_only_notebook_id):
"""Test new feature against real API."""
result = await client.some_api.new_feature(test_notebook_id, "param")
# Use read_only_notebook_id for read-only tests
# Use temp_notebook for CRUD tests
# Use generation_notebook_id for artifact generation tests
# See docs/contributing/testing.md for fixture guidance
result = await client.some_api.new_feature(read_only_notebook_id, "param")
assert result is not None
```

2
docs/contributing/testing.md
View file

@ -64,7 +64,7 @@ Or set the environment variable directly:
export NOTEBOOKLM_READ_ONLY_NOTEBOOK_ID="your-notebook-id-here"
```
**Note:** The generation notebook is auto-created on first run and stored in `~/.notebooklm/generation_notebook_id`. You don't need to configure it manually.
**Note:** The generation notebook is auto-created on first run and stored in `NOTEBOOKLM_HOME/generation_notebook_id` (default: `~/.notebooklm/generation_notebook_id`). You don't need to configure it manually.
### 4. Verify Setup