Contributing

binarydb/
├── binarydb/
│   ├── __init__.py           # Package initialization
│   ├── database.py           # ✅ Core database implementation
│   ├── errors.py             # ✅ Custom exception classes
│   ├── cache.py              # 🚧 Minimal definitions (in progress)
│   ├── index.py              # ⏳ Pending - indexing structures
│   ├── lock.py               # ⏳ Pending - concurrency control
│   ├── transaction.py        # ⏳ Pending - transaction helpers
│   ├── utils.py              # ⏳ Pending - utility functions
│   └── wal.py                # ⏳ Pending - write-ahead logging
└── README.md                 # Project documentation

# Use type hints
def my_function(key: str, value: Any) -> bool:
    """Clear docstring explaining the function."""
    pass

# Use descriptive variable names
db_path = Path("./data/mydb")
user_record = {"name": "Alice", "age": 30}

# Follow PEP 8 style guidelines
# Use 4 spaces for indentation
# Maximum line length: 88 characters (Black formatter)

import unittest
from binarydb.database import Database
from pathlib import Path
import tempfile

class TestNewFeature(unittest.TestCase):
    def setUp(self):
        self.temp_dir = tempfile.mkdtemp()
        self.db_path = Path(self.temp_dir) / "test_db"
    
    def tearDown(self):
        # Clean up test files
        if self.db_path.with_suffix('.pkl').exists():
            self.db_path.with_suffix('.pkl').unlink()
    
    def test_feature(self):
        db = Database(self.db_path)
        # Test your feature
        self.assertTrue(True)
        db.close()

def new_feature(self, key: str, value: Any) -> None:
    """
    Brief description of what this function does.
    
    Args:
        key: Description of the key parameter.
        value: Description of the value parameter.
    
    Raises:
        KeyValidationError: When the key is invalid.
        DatabaseError: When the database is closed.
    
    Example:
        >>> db = Database("./data/mydb")
        >>> db.new_feature("key", "value")
    """
    pass

# Good commit messages
git commit -m "Add: WAL implementation with log compaction"
git commit -m "Fix: Handle edge case in transaction rollback"
git commit -m "Update: Improve error messages for key validation"
git commit -m "Test: Add comprehensive tests for indexing module"

# Bad commit messages
git commit -m "fixed stuff"
git commit -m "updates"
git commit -m "wip"

## Feature Request: Add B-tree indexing

**Description:**
Implement B-tree-based indexing to support efficient range queries.

**Motivation:**
Current implementation only supports exact key lookups. Range queries
require scanning all keys, which is inefficient.

**Proposed Implementation:**
- Add BTreeIndex class in index.py
- Support range(), greater_than(), less_than() queries
- Persist indexes alongside database file

**Questions:**
- Should indexes be rebuilt automatically on load()?
- What should be the default node size?

## Implement Write-Ahead Logging

Closes #123

**Changes:**
- Implemented WAL class in wal.py
- Added log writing before each commit
- Added recovery mechanism in load()
- Added log compaction to prevent unbounded growth

**Testing:**
- Added 15 new tests covering WAL operations
- Tested crash recovery scenarios
- Verified performance impact is minimal

**Documentation:**
- Added docstrings to all public methods
- Updated README with WAL information

# Clone the repository
git clone https://github.com/raulnovo/binarydb.git
cd binarydb

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install in development mode
pip install -e .

# Install development dependencies (when added)
pip install -e ".[dev]"

# Run tests (when test suite is added)
python -m pytest tests/

# Try the basic example
from binarydb.database import Database

db = Database("./datos/mydb")
db.load()
db.set("usuario:1", {"nombre": "Ana", "edad": 30})
print(db.get("usuario:1"))
db.commit()
db.close()