Metadata-Version: 2.4
Name: weav
Version: 0.1.5
Summary: A personal note archival and versioning system (git-like).
Author-email: Feng-Yu You <anaresil137@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Feng-Yu You
        
        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.
        
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.0
Requires-Dist: rapidfuzz>=3.0
Dynamic: license-file

# Weav — personal note archival & versioning (MVP)

Quick start (local):

1. Clone files and save project.
2. Install in editable mode (recommended for iteration):

```bash
pip install -e .
```

3. Initialize repo in a folder where you'll store notes:

```bash
mkdir mynotes && cd mynotes
weav init
```

4. Add a file:

```bash
weav add /path/to/note.pdf
```

5. See staged items:

```bash
weav status
```

6. Commit staged:

```bash
weav commit -m “Daily notes”
```

7. Search:

```bash
weav search lorentz
```

8. Show a note:

```bash
weav show <note_id_or_blob_hash>
```

Docker:

```bash
docker build -t weav .
docker run –rm -it -v $(pwd)/mynotes:/data weav init
```

Design notes:
- Minimal, local-first; stores files into `.weav/objects/<sha256>` and structured metadata in `.weav/weav.db`.
- Each "note" is 1:1 with a blob (file).
- Commit collects staged notes and computes a deterministic merkle-ish commit hash (sha256 of sorted blob-hashes).
- `weav verify` checks integrity.
