Metadata-Version: 2.4
Name: typed-json-db
Version: 0.2.2
Summary: A simple JSON-based database for Python applications
Project-URL: Homepage, https://github.com/frangiz/typed-json-db
Project-URL: Repository, https://github.com/frangiz/typed-json-db
Project-URL: Issues, https://github.com/frangiz/typed-json-db/issues
Project-URL: Documentation, https://github.com/frangiz/typed-json-db#readme
Author-email: frangiz <frangiz@gmail.com>
Maintainer-email: frangiz <frangiz@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Björn Olsson Jarl
        
        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.
License-File: LICENSE
Keywords: database,dataclass,json,persistence,storage,typed
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Database
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# Simple JSON DB

A lightweight, type-safe JSON-based database for Python applications using dataclasses. Perfect for small projects, prototyping, and situations where you need a simple persistent storage solution with type safety.

## Features

- 🚀 **Type-safe**: Uses Python dataclasses for structured data
- 📁 **File-based**: Uses JSON files for storage - easy to inspect and backup
- 🔍 **Query support**: Find records using attribute-based queries
- 🔧 **CRUD operations**: Create, Read, Update, Delete operations
- � **Primary key support**: Optional configurable primary key with uniqueness enforcement
- ⚡ **Indexing**: Automatic indexing for primary key operations for fast lookups
- �📦 **Zero dependencies**: No external dependencies required
- 🐍 **Type hints**: Full type hint support with generics
- ✅ **Well tested**: Comprehensive test suite
- 🆔 **UUID support**: Automatic handling of UUID fields

## Installation

Install from PyPI using pip:

```bash
pip install typed-json-db
```

Or using uv:

```bash
uv add typed-json-db
```

## Quick Start

```python
from dataclasses import dataclass
from enum import Enum
import uuid
from pathlib import Path
from typed_json_db import JsonDB

# Define your data structure using dataclasses
class Status(Enum):
    PENDING = "pending"
    ACTIVE = "active"
    COMPLETED = "completed"

@dataclass
class User:
    id: uuid.UUID
    name: str
    email: str
    status: Status
    age: int

# Create or connect to a database
db = JsonDB(User, Path("users.json"))

# Or create with a primary key for better performance and uniqueness enforcement
db = JsonDB(User, Path("users.json"), primary_key="id")

# Add records
user1 = User(
    id=uuid.uuid4(),
    name="Alice Johnson", 
    email="alice@example.com",
    status=Status.ACTIVE,
    age=30
)
db.add(user1)

# Find records
active_users = db.find(status=Status.ACTIVE)
specific_user = db.get(user1.id)
all_users = db.all()

# Update records (modify and save)
user1.age = 31
db.update(user1)

# Remove records
db.remove(user1.id)
```

## API Reference

### JsonDB[T](data_class: Type[T], file_path: Path, primary_key: Optional[str] = None)

Create a new type-safe database instance.

**Parameters:**
- `data_class`: The dataclass type this database will store
- `file_path`: Path to the JSON database file
- `primary_key`: Optional field name to use as primary key for uniqueness and indexing

### Methods

#### add(item: T) -> T
Add a new item to the database and save automatically. If a primary key is configured, enforces uniqueness.

#### get(primary_key_value: Any) -> Optional[T]
Get an item by its primary key value. Returns None if not found. Requires a primary key to be configured.

#### find(**kwargs) -> List[T]
Find all items matching the given attribute criteria. Requires at least one search criterion.

#### all() -> List[T]
Get all items in the database.

#### update(item: T) -> T
Update an existing item (by primary key) and save automatically. Requires a primary key to be configured.

#### remove(primary_key_value: Any) -> bool
Remove an item by its primary key value. Returns True if removed, False if not found. Requires a primary key to be configured.

#### save() -> None
Manually save the database (automatic for add/update/remove operations).

## Advanced Features

### Primary Key Configuration

Configure a primary key for better performance and data integrity:

```python
@dataclass
class Product:
    sku: str
    name: str
    price: float

# Use 'sku' as primary key
db = JsonDB(Product, Path("products.json"), primary_key="sku")

# Primary key operations are fast (O(1)) and enforce uniqueness
product = Product(sku="ABC123", name="Widget", price=9.99)
db.add(product)

# Fast retrieval by primary key
found = db.get("ABC123")

# Trying to add duplicate primary key raises an exception
duplicate = Product(sku="ABC123", name="Another Widget", price=19.99)
# db.add(duplicate)  # Raises JsonDBException
```

### Database Operations Without Primary Key

You can still use the database without a primary key, but some operations will be limited:

```python
# No primary key specified
db = JsonDB(User, Path("users.json"))

# These work normally
db.add(user)
users = db.find(status=Status.ACTIVE)
all_users = db.all()

# These require a primary key and will raise JsonDBException
# db.get(some_id)      # Not available
# db.update(user)      # Not available  
# db.remove(some_id)   # Not available
```

### Automatic Type Conversion

The database automatically handles serialization/deserialization of:
- UUID fields
- Enum values  
- datetime and date objects
- Complex nested dataclass structures

### Performance and Indexing

When a primary key is configured, the database automatically creates an in-memory index for fast lookups:

- **Primary key operations** (`get`, single-key `find`) are O(1) - constant time
- **Non-primary key searches** use linear search - O(n) time
- **Index is automatically maintained** during add, update, and remove operations
- **Index is rebuilt** when loading the database from disk

```python
# Fast O(1) operations with primary key
db = JsonDB(User, Path("users.json"), primary_key="id")
user = db.get(user_id)  # Very fast, uses index

# Linear search operations (still fast for reasonable dataset sizes)
active_users = db.find(status=Status.ACTIVE)  # Searches all records
```

### Error Handling

```python
from typed_json_db import JsonDBException

try:
    db.add(invalid_item)
except JsonDBException as e:
    print(f"Database error: {e}")
```

## Development

This project uses `uv` for dependency management and packaging.

### Setup Development Environment

```bash
# Clone the repository
git clone https://github.com/frangiz/typed-json-db.git
cd typed-json-db

# Install development dependencies
uv sync
```

### Running Tests

```bash
make test
```

### Code Formatting and Checking

```bash
make format
make check
```

### Building the Package

```bash
make build
```

### Publishing to PyPI

```bash
# Test on TestPyPI first
make publish-test

# Publish to PyPI
make publish
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.