basic-memory 0.16.0__tar.gz → 0.16.2__tar.gz

basic_memory-0.16.2/.claude/commands/release/release.md

@@ -0,0 +1,169 @@
+# /release - Create Stable Release
+
+Create a stable release using the automated justfile target with comprehensive validation.
+
+## Usage
+```
+/release <version>
+```
+
+**Parameters:**
+- `version` (required): Release version like `v0.13.2`
+
+## Implementation
+
+You are an expert release manager for the Basic Memory project. When the user runs `/release`, execute the following steps:
+
+### Step 1: Pre-flight Validation
+
+#### Version Check
+1. Check current version in `src/basic_memory/__init__.py`
+2. Verify new version format matches `v\d+\.\d+\.\d+` pattern
+3. Confirm version is higher than current version
+
+#### Git Status
+1. Check current git status for uncommitted changes
+2. Verify we're on the `main` branch
+3. Confirm no existing tag with this version
+
+#### Documentation Validation
+1. **Changelog Check**
+   - CHANGELOG.md contains entry for target version
+   - Entry includes all major features and fixes
+   - Breaking changes are documented
+
+### Step 2: Use Justfile Automation
+Execute the automated release process:
+```bash
+just release <version>
+```
+
+The justfile target handles:
+- ✅ Version format validation
+- ✅ Git status and branch checks
+- ✅ Quality checks (`just check` - lint, format, type-check, tests)
+- ✅ Version update in `src/basic_memory/__init__.py`
+- ✅ Automatic commit with proper message
+- ✅ Tag creation and pushing to GitHub
+- ✅ Release workflow trigger (automatic on tag push)
+
+The GitHub Actions workflow (`.github/workflows/release.yml`) then:
+- ✅ Builds the package using `uv build`
+- ✅ Creates GitHub release with auto-generated notes
+- ✅ Publishes to PyPI
+- ✅ Updates Homebrew formula (stable releases only)
+
+### Step 3: Monitor Release Process
+1. Verify tag push triggered the workflow (should start automatically within seconds)
+2. Monitor workflow progress at: https://github.com/basicmachines-co/basic-memory/actions
+3. Watch for successful completion of both jobs:
+   - `release` - Builds package and publishes to PyPI
+   - `homebrew` - Updates Homebrew formula (stable releases only)
+4. Check for any workflow failures and investigate logs if needed
+
+### Step 4: Post-Release Validation
+
+#### GitHub Release
+1. Verify GitHub release is created at: https://github.com/basicmachines-co/basic-memory/releases/tag/<version>
+2. Check that release notes are auto-generated from commits
+3. Validate release assets (`.whl` and `.tar.gz` files are attached)
+
+#### PyPI Publication
+1. Verify package published at: https://pypi.org/project/basic-memory/<version>/
+2. Test installation: `uv tool install basic-memory`
+3. Verify installed version: `basic-memory --version`
+
+#### Homebrew Formula (Stable Releases Only)
+1. Check formula update at: https://github.com/basicmachines-co/homebrew-basic-memory
+2. Verify formula version matches release
+3. Test Homebrew installation: `brew install basicmachines-co/basic-memory/basic-memory`
+
+#### Website Updates
+
+**1. basicmachines.co** (`/Users/drew/code/basicmachines.co`)
+   - **Goal**: Update version number displayed on the homepage
+   - **Location**: Search for "Basic Memory v0." in the codebase to find version displays
+   - **What to update**:
+     - Hero section heading that shows "Basic Memory v{VERSION}"
+     - "What's New in v{VERSION}" section heading
+     - Feature highlights array (look for array of features with title/description)
+   - **Process**:
+     1. Pull latest from GitHub: `git pull origin main`
+     2. Create release branch: `git checkout -b release/v{VERSION}`
+     3. Search codebase for current version number (e.g., "v0.16.1")
+     4. Update version numbers to new release version
+     5. Update feature highlights with 3-5 key features from this release (extract from CHANGELOG.md)
+     6. Commit changes: `git commit -m "chore: update to v{VERSION}"`
+     7. Push branch: `git push origin release/v{VERSION}`
+   - **Deploy**: Follow deployment process for basicmachines.co
+
+**2. docs.basicmemory.com** (`/Users/drew/code/docs.basicmemory.com`)
+   - **Goal**: Add new release notes section to the latest-releases page
+   - **File**: `src/pages/latest-releases.mdx`
+   - **What to do**:
+     1. Pull latest from GitHub: `git pull origin main`
+     2. Create release branch: `git checkout -b release/v{VERSION}`
+     3. Read the existing file to understand the format and structure
+     4. Read `/Users/drew/code/basic-memory/CHANGELOG.md` to get release content
+     5. Add new release section **at the top** (after MDX imports, before other releases)
+     6. Follow the existing pattern:
+        - Heading: `## [v{VERSION}](github-link) — YYYY-MM-DD`
+        - Focus statement if applicable
+        - `<Info>` block with highlights (3-5 key items)
+        - Sections for Features, Bug Fixes, Breaking Changes, etc.
+        - Link to full changelog at the end
+        - Separator `---` between releases
+     7. Commit changes: `git commit -m "docs: add v{VERSION} release notes"`
+     8. Push branch: `git push origin release/v{VERSION}`
+   - **Source content**: Extract and format sections from CHANGELOG.md for this version
+   - **Deploy**: Follow deployment process for docs.basicmemory.com
+
+**4. Announce Release**
+   - Post to Discord community if significant changes
+   - Update social media if major release
+   - Notify users via appropriate channels
+
+## Pre-conditions Check
+Before starting, verify:
+- [ ] All beta testing is complete
+- [ ] Critical bugs are fixed
+- [ ] Breaking changes are documented
+- [ ] CHANGELOG.md is updated (if needed)
+- [ ] Version number follows semantic versioning
+
+## Error Handling
+- If `just release` fails, examine the error output for specific issues
+- If quality checks fail, fix issues and retry
+- If changelog entry missing, update CHANGELOG.md and commit before retrying
+- If GitHub Actions fail, check workflow logs for debugging
+
+## Success Output
+```
+🎉 Stable Release v0.13.2 Created Successfully!
+
+🏷️  Tag: v0.13.2
+📋 GitHub Release: https://github.com/basicmachines-co/basic-memory/releases/tag/v0.13.2
+📦 PyPI: https://pypi.org/project/basic-memory/0.13.2/
+🍺 Homebrew: https://github.com/basicmachines-co/homebrew-basic-memory
+🚀 GitHub Actions: Completed
+
+Install with pip/uv:
+  uv tool install basic-memory
+
+Install with Homebrew:
+  brew install basicmachines-co/basic-memory/basic-memory
+
+Users can now upgrade:
+  uv tool upgrade basic-memory
+  brew upgrade basic-memory
+```
+
+## Context
+- This creates production releases used by end users
+- Must pass all quality gates before proceeding
+- Uses the automated justfile target for consistency
+- Version is automatically updated in `__init__.py`
+- Triggers automated GitHub release with changelog
+- Package is published to PyPI for `pip` and `uv` users
+- Homebrew formula is automatically updated for stable releases
+- Supports multiple installation methods (uv, pip, Homebrew)

{basic_memory-0.16.0 → basic_memory-0.16.2}/CHANGELOG.md

@@ -1,5 +1,38 @@
 # CHANGELOG
 
+## v0.16.2 (2025-11-16)
+
+### Bug Fixes
+
+- **#429**: Use platform-native path separators in config.json
+  ([`6517e98`](https://github.com/basicmachines-co/basic-memory/commit/6517e98))
+  - Fixes config.json path separator issues on Windows
+  - Uses os.path.join for platform-native path construction
+  - Ensures consistent path handling across platforms
+
+- **#427**: Add rclone installation checks for Windows bisync commands
+  ([`1af0539`](https://github.com/basicmachines-co/basic-memory/commit/1af0539))
+  - Validates rclone installation before running bisync commands
+  - Provides clear error messages when rclone is not installed
+  - Improves user experience on Windows
+
+- **#421**: Main project always recreated on project list command
+  ([`cad7019`](https://github.com/basicmachines-co/basic-memory/commit/cad7019))
+  - Fixes issue where main project was recreated unnecessarily
+  - Improves project list command reliability
+  - Reduces unnecessary file system operations
+
+## v0.16.1 (2025-11-11)
+
+### Bug Fixes
+
+- **#422**: Handle Windows line endings in rclone bisync
+  ([`e9d0a94`](https://github.com/basicmachines-co/basic-memory/commit/e9d0a94))
+  - Added `--compare=modtime` flag to rclone bisync to ignore size differences from line ending conversions
+  - Fixes issue where LF→CRLF conversion on Windows was treated as file corruption
+  - Resolves "corrupted on transfer: sizes differ" errors during cloud sync on Windows
+  - Users will need to run `--resync` once after updating to establish new baseline
+
 ## v0.16.0 (2025-11-10)
 
 ### Features

{basic_memory-0.16.0 → basic_memory-0.16.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: basic-memory
-Version: 0.16.0
+Version: 0.16.2
 Summary: Local-first knowledge management combining Zettelkasten with knowledge graphs
 Project-URL: Homepage, https://github.com/basicmachines-co/basic-memory
 Project-URL: Repository, https://github.com/basicmachines-co/basic-memory

{basic_memory-0.16.0 → basic_memory-0.16.2}/src/basic_memory/__init__.py

@@ -1,7 +1,7 @@
 """basic-memory - Local-first knowledge management combining Zettelkasten with knowledge graphs"""
 
 # Package version - updated by release automation
-__version__ = "0.16.0"
+__version__ = "0.16.2"
 
 # API version for FastAPI - independent of package version
 __api_version__ = "v0"

{basic_memory-0.16.0 → basic_memory-0.16.2}/src/basic_memory/cli/commands/cloud/rclone_commands.py

@@ -16,6 +16,7 @@ from typing import Optional
 
 from rich.console import Console
 
+from basic_memory.cli.commands.cloud.rclone_installer import is_rclone_installed
 from basic_memory.utils import normalize_project_path
 
 console = Console()
@@ -27,6 +28,21 @@ class RcloneError(Exception):
     pass
 
 
+def check_rclone_installed() -> None:
+    """Check if rclone is installed and raise helpful error if not.
+
+    Raises:
+        RcloneError: If rclone is not installed with installation instructions
+    """
+    if not is_rclone_installed():
+        raise RcloneError(
+            "rclone is not installed.\n\n"
+            "Install rclone by running: bm cloud setup\n"
+            "Or install manually from: https://rclone.org/downloads/\n\n"
+            "Windows users: Ensure you have a package manager installed (winget, chocolatey, or scoop)"
+        )
+
+
 @dataclass
 class SyncProject:
     """Project configured for cloud sync.
@@ -124,8 +140,10 @@ def project_sync(
         True if sync succeeded, False otherwise
 
     Raises:
-        RcloneError: If project has no local_sync_path configured
+        RcloneError: If project has no local_sync_path configured or rclone not installed
     """
+    check_rclone_installed()
+
     if not project.local_sync_path:
         raise RcloneError(f"Project {project.name} has no local_sync_path configured")
 
@@ -166,6 +184,7 @@ def project_bisync(
     Uses rclone bisync with balanced defaults:
     - conflict_resolve: newer (auto-resolve to most recent)
     - max_delete: 25 (safety limit)
+    - compare: modtime (ignore size differences from line ending conversions)
     - check_access: false (skip for performance)
 
     Args:
@@ -179,8 +198,10 @@ def project_bisync(
         True if bisync succeeded, False otherwise
 
     Raises:
-        RcloneError: If project has no local_sync_path or needs --resync
+        RcloneError: If project has no local_sync_path, needs --resync, or rclone not installed
     """
+    check_rclone_installed()
+
     if not project.local_sync_path:
         raise RcloneError(f"Project {project.name} has no local_sync_path configured")
 
@@ -201,6 +222,7 @@ def project_bisync(
         "--resilient",
         "--conflict-resolve=newer",
         "--max-delete=25",
+        "--compare=modtime",  # Ignore size differences from line ending conversions
         "--filter-from",
         str(filter_path),
         "--workdir",
@@ -247,8 +269,10 @@ def project_check(
         True if files match, False if differences found
 
     Raises:
-        RcloneError: If project has no local_sync_path configured
+        RcloneError: If project has no local_sync_path configured or rclone not installed
     """
+    check_rclone_installed()
+
     if not project.local_sync_path:
         raise RcloneError(f"Project {project.name} has no local_sync_path configured")
 
@@ -289,7 +313,10 @@ def project_ls(
 
     Raises:
         subprocess.CalledProcessError: If rclone command fails
+        RcloneError: If rclone is not installed
     """
+    check_rclone_installed()
+
     remote_path = get_project_remote(project, bucket_name)
     if path:
         remote_path = f"{remote_path}/{path}"

{basic_memory-0.16.0 → basic_memory-0.16.2}/src/basic_memory/cli/commands/cloud/rclone_installer.py

@@ -151,11 +151,25 @@ def install_rclone_windows() -> None:
         except RcloneInstallError:
             console.print("[yellow]scoop installation failed[/yellow]")
 
-    # No package manager available
-    raise RcloneInstallError(
-        "Could not install rclone automatically. Please install a package manager "
-        "(winget, chocolatey, or scoop) or install rclone manually from https://rclone.org/downloads/"
+    # No package manager available - provide detailed instructions
+    error_msg = (
+        "Could not install rclone automatically.\n\n"
+        "Windows requires a package manager to install rclone. Options:\n\n"
+        "1. Install winget (recommended, built into Windows 11):\n"
+        "   - Windows 11: Already installed\n"
+        "   - Windows 10: Install 'App Installer' from Microsoft Store\n"
+        "   - Then run: bm cloud setup\n\n"
+        "2. Install chocolatey:\n"
+        "   - Visit: https://chocolatey.org/install\n"
+        "   - Then run: bm cloud setup\n\n"
+        "3. Install scoop:\n"
+        "   - Visit: https://scoop.sh\n"
+        "   - Then run: bm cloud setup\n\n"
+        "4. Manual installation:\n"
+        "   - Download from: https://rclone.org/downloads/\n"
+        "   - Extract and add to PATH\n"
     )
+    raise RcloneInstallError(error_msg)
 
 
 def install_rclone(platform_override: Optional[str] = None) -> None:

{basic_memory-0.16.0 → basic_memory-0.16.2}/src/basic_memory/config.py

@@ -63,8 +63,10 @@ class BasicMemoryConfig(BaseSettings):
 
     projects: Dict[str, str] = Field(
         default_factory=lambda: {
-            "main": Path(os.getenv("BASIC_MEMORY_HOME", Path.home() / "basic-memory")).as_posix()
-        },
+            "main": str(Path(os.getenv("BASIC_MEMORY_HOME", Path.home() / "basic-memory")))
+        }
+        if os.getenv("BASIC_MEMORY_HOME")
+        else {},
         description="Mapping of project names to their filesystem paths",
     )
     default_project: str = Field(
@@ -192,15 +194,16 @@ class BasicMemoryConfig(BaseSettings):
 
     def model_post_init(self, __context: Any) -> None:
         """Ensure configuration is valid after initialization."""
-        # Ensure main project exists
-        if "main" not in self.projects:  # pragma: no cover
-            self.projects["main"] = (
+        # Ensure at least one project exists; if none exist then create main
+        if not self.projects:  # pragma: no cover
+            self.projects["main"] = str(
                 Path(os.getenv("BASIC_MEMORY_HOME", Path.home() / "basic-memory"))
-            ).as_posix()
+            )
 
-        # Ensure default project is valid
+        # Ensure default project is valid (i.e. points to an existing project)
         if self.default_project not in self.projects:  # pragma: no cover
-            self.default_project = "main"
+            # Set default to first available project
+            self.default_project = next(iter(self.projects.keys()))
 
     @property
     def app_database_path(self) -> Path:
@@ -358,7 +361,7 @@ class ConfigManager:
 
         # Load config, modify it, and save it
         config = self.load_config()
-        config.projects[name] = project_path.as_posix()
+        config.projects[name] = str(project_path)
         self.save_config(config)
         return ProjectConfig(name=name, home=project_path)
 

{basic_memory-0.16.0 → basic_memory-0.16.2}/test-int/cli/test_project_commands_integration.py

@@ -119,3 +119,45 @@ def test_project_set_default(app_config, config_manager):
         for line in lines:
             if "another-project" in line:
                 assert "[X]" in line
+
+
+def test_remove_main_project(app_config, config_manager):
+    """Test that removing main project then listing projects prevents main from reappearing (issue #397)."""
+    runner = CliRunner()
+
+    # Create separate temp dirs for each project
+    with (
+        tempfile.TemporaryDirectory() as main_dir,
+        tempfile.TemporaryDirectory() as new_default_dir,
+    ):
+        main_path = Path(main_dir)
+        new_default_path = Path(new_default_dir)
+
+        # Ensure main exists
+        result = runner.invoke(app, ["project", "list"])
+        if "main" not in result.stdout:
+            result = runner.invoke(app, ["project", "add", "main", str(main_path)])
+            print(result.stdout)
+            assert result.exit_code == 0
+
+        # Confirm main is present
+        result = runner.invoke(app, ["project", "list"])
+        assert "main" in result.stdout
+
+        # Add a second project
+        result = runner.invoke(app, ["project", "add", "new_default", str(new_default_path)])
+        assert result.exit_code == 0
+
+        # Set new_default as default (if needed)
+        result = runner.invoke(app, ["project", "default", "new_default"])
+        assert result.exit_code == 0
+
+        # Remove main
+        result = runner.invoke(app, ["project", "remove", "main"])
+        assert result.exit_code == 0
+
+        # Confirm only new_default exists and main does not
+        result = runner.invoke(app, ["project", "list"])
+        assert result.exit_code == 0
+        assert "main" not in result.stdout
+        assert "new_default" in result.stdout

{basic_memory-0.16.0 → basic_memory-0.16.2}/tests/api/test_project_router.py

@@ -219,20 +219,20 @@ async def test_update_project_path_endpoint(test_config, client, project_service
     test_project_name = "test-update-project"
     with tempfile.TemporaryDirectory() as temp_dir:
         test_root = Path(temp_dir)
-        old_path = (test_root / "old-location").as_posix()
-        new_path = (test_root / "new-location").as_posix()
+        old_path = test_root / "old-location"
+        new_path = test_root / "new-location"
 
-        await project_service.add_project(test_project_name, old_path)
+        await project_service.add_project(test_project_name, str(old_path))
 
         try:
             # Verify initial state
             project = await project_service.get_project(test_project_name)
             assert project is not None
-            assert project.path == old_path
+            assert Path(project.path) == old_path
 
             # Update the project path
             response = await client.patch(
-                f"{project_url}/project/{test_project_name}", json={"path": new_path}
+                f"{project_url}/project/{test_project_name}", json={"path": str(new_path)}
             )
 
             # Verify response
@@ -248,16 +248,16 @@ async def test_update_project_path_endpoint(test_config, client, project_service
 
             # Check old project data
             assert data["old_project"]["name"] == test_project_name
-            assert data["old_project"]["path"] == old_path
+            assert Path(data["old_project"]["path"]) == old_path
 
             # Check new project data
             assert data["new_project"]["name"] == test_project_name
-            assert data["new_project"]["path"] == new_path
+            assert Path(data["new_project"]["path"]) == new_path
 
             # Verify project was actually updated in database
             updated_project = await project_service.get_project(test_project_name)
             assert updated_project is not None
-            assert updated_project.path == new_path
+            assert Path(updated_project.path) == new_path
 
         finally:
             # Clean up

{basic_memory-0.16.0 → basic_memory-0.16.2}/tests/services/test_project_service.py

@@ -77,18 +77,18 @@ async def test_project_operations_sync_methods(
     test_project_name = f"test-project-{os.urandom(4).hex()}"
     with tempfile.TemporaryDirectory() as temp_dir:
         test_root = Path(temp_dir)
-        test_project_path = (test_root / "test-project").as_posix()
+        test_project_path = test_root / "test-project"
 
         # Make sure the test directory exists
-        os.makedirs(test_project_path, exist_ok=True)
+        test_project_path.mkdir(parents=True, exist_ok=True)
 
         try:
             # Test adding a project (using ConfigManager directly)
-            config_manager.add_project(test_project_name, test_project_path)
+            config_manager.add_project(test_project_name, str(test_project_path))
 
             # Verify it was added
             assert test_project_name in project_service.projects
-            assert project_service.projects[test_project_name] == test_project_path
+            assert Path(project_service.projects[test_project_name]) == test_project_path
 
             # Test setting as default
             original_default = project_service.default_project
@@ -173,24 +173,24 @@ async def test_add_project_async(project_service: ProjectService):
     test_project_name = f"test-async-project-{os.urandom(4).hex()}"
     with tempfile.TemporaryDirectory() as temp_dir:
         test_root = Path(temp_dir)
-        test_project_path = (test_root / "test-async-project").as_posix()
+        test_project_path = test_root / "test-async-project"
 
         # Make sure the test directory exists
-        os.makedirs(test_project_path, exist_ok=True)
+        test_project_path.mkdir(parents=True, exist_ok=True)
 
         try:
             # Test adding a project
-            await project_service.add_project(test_project_name, test_project_path)
+            await project_service.add_project(test_project_name, str(test_project_path))
 
             # Verify it was added to config
             assert test_project_name in project_service.projects
-            assert project_service.projects[test_project_name] == test_project_path
+            assert Path(project_service.projects[test_project_name]) == test_project_path
 
             # Verify it was added to the database
             project = await project_service.repository.get_by_name(test_project_name)
             assert project is not None
             assert project.name == test_project_name
-            assert project.path == test_project_path
+            assert Path(project.path) == test_project_path
 
         finally:
             # Clean up
@@ -569,34 +569,34 @@ async def test_move_project(project_service: ProjectService):
     test_project_name = f"test-move-project-{os.urandom(4).hex()}"
     with tempfile.TemporaryDirectory() as temp_dir:
         test_root = Path(temp_dir)
-        old_path = (test_root / "old-location").as_posix()
-        new_path = (test_root / "new-location").as_posix()
+        old_path = test_root / "old-location"
+        new_path = test_root / "new-location"
 
         # Create old directory
-        os.makedirs(old_path, exist_ok=True)
+        old_path.mkdir(parents=True, exist_ok=True)
 
         try:
             # Add project with initial path
-            await project_service.add_project(test_project_name, old_path)
+            await project_service.add_project(test_project_name, str(old_path))
 
             # Verify initial state
             assert test_project_name in project_service.projects
-            assert project_service.projects[test_project_name] == old_path
+            assert Path(project_service.projects[test_project_name]) == old_path
 
             project = await project_service.repository.get_by_name(test_project_name)
             assert project is not None
-            assert project.path == old_path
+            assert Path(project.path) == old_path
 
             # Move project to new location
-            await project_service.move_project(test_project_name, new_path)
+            await project_service.move_project(test_project_name, str(new_path))
 
             # Verify config was updated
-            assert project_service.projects[test_project_name] == new_path
+            assert Path(project_service.projects[test_project_name]) == new_path
 
             # Verify database was updated
             updated_project = await project_service.repository.get_by_name(test_project_name)
             assert updated_project is not None
-            assert updated_project.path == new_path
+            assert Path(updated_project.path) == new_path
 
             # Verify new directory was created
             assert os.path.exists(new_path)
@@ -624,17 +624,17 @@ async def test_move_project_db_mismatch(project_service: ProjectService):
     test_project_name = f"test-move-mismatch-{os.urandom(4).hex()}"
     with tempfile.TemporaryDirectory() as temp_dir:
         test_root = Path(temp_dir)
-        old_path = (test_root / "old-location").as_posix()
-        new_path = (test_root / "new-location").as_posix()
+        old_path = test_root / "old-location"
+        new_path = test_root / "new-location"
 
         # Create directories
-        os.makedirs(old_path, exist_ok=True)
+        old_path.mkdir(parents=True, exist_ok=True)
 
         config_manager = project_service.config_manager
 
         try:
             # Add project to config only (not to database)
-            config_manager.add_project(test_project_name, old_path)
+            config_manager.add_project(test_project_name, str(old_path))
 
             # Verify it's in config but not in database
             assert test_project_name in project_service.projects
@@ -643,10 +643,10 @@ async def test_move_project_db_mismatch(project_service: ProjectService):
 
             # Try to move project - should fail and restore config
             with pytest.raises(ValueError, match="not found in database"):
-                await project_service.move_project(test_project_name, new_path)
+                await project_service.move_project(test_project_name, str(new_path))
 
             # Verify config was restored to original path
-            assert project_service.projects[test_project_name] == old_path
+            assert Path(project_service.projects[test_project_name]) == old_path
 
         finally:
             # Clean up