nobox 0.1.0__tar.gz

nobox-0.1.0/.gitignore

@@ -0,0 +1,74 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Virtual environments
+venv/
+env/
+ENV/
+env.bak/
+venv.bak/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Project specific
+*.db
+*.sqlite
+*.sqlite3
+CLAUDE.md

nobox-0.1.0/CHANGELOG.md

@@ -0,0 +1,123 @@
+# NoBox Changelog
+
+## [0.1.0] - 2026-02-09 (Pre-release)
+
+### Added
+
+#### Hierarchical Discovery Interface 🎉
+- **List databases** command with three syntax options:
+  - `jb --list` or `jb -l` (flag-based)
+  - `jb databases` (explicit command)
+  - Works for both JSON (`jb`) and YAML (`yb`) formats
+
+- **List collections** command with three syntax options:
+  - `jb <database> --list` or `jb <database> -l` (flag-based)
+  - `jb <database> collections` (explicit command)
+  - Shows all collections within a database
+
+- **Hierarchical navigation** pattern:
+  1. `jb -l` → databases
+  2. `jb mydb -l` → collections
+  3. `jb mydb users keys` → keys
+  4. `jb mydb users get alice` → record data
+
+#### Command Aliases
+- Added `jb` as short alias for `jsonbox`
+- Added `yb` as short alias for `yamlbox`
+- Aliases registered in both `setup.py` and `pyproject.toml`
+
+#### Import from stdin 🎉
+- **Import command** for bulk data loading:
+  - `cat file.txt | jb mydb users import`
+  - Format: `key field:value field:value ...` (one record per line)
+  - Auto type conversion (integers, floats)
+  - Skips empty lines and comments (# prefix)
+  - Error handling with detailed reporting
+  - Best-effort import (continues on errors)
+  - Works with both JSON and YAML formats
+
+#### Core Features (Previously Implemented)
+- Driver architecture (JSONDriver, YAMLDriver)
+- DictStore with full CRUD operations
+- Multiple output formats:
+  - Pretty table (default)
+  - JSON (`--json`)
+  - JSON Lines (`--jsonl`)
+  - One-line format (`--oneline`)
+  - CSV (`--csv`)
+- Case-insensitive key storage
+- Cross-platform storage via ConfBox
+
+### Changed
+
+#### Documentation
+- **README.md**:
+  - Added "Hierarchical Navigation" section with examples
+  - Added "Complete Workflow Example" demonstrating end-to-end usage
+  - Added "Quick Reference Card" for common commands
+  - Updated all use case examples to show discovery commands
+  - Updated command sections with database/collection listing
+
+- **DESIGN.md**:
+  - Added `databases` and `collections` to operations table
+  - Added "Hierarchical Navigation" section
+  - Updated examples to show discovery workflow
+  - Updated roadmap with completed phases
+  - Added design decision entries for new features (2026-02-09)
+
+- **CLAUDE.md**:
+  - Updated Quick Reference with discovery commands
+  - Updated Development Status with current progress
+  - Added hierarchical discovery to Key Design Decisions
+  - Clarified TODO items (import command, tests)
+
+#### Code
+- **store.py**:
+  - Added `DictStore.list_databases(driver)` class method
+  - Lists all databases for a given format (JSON/YAML)
+
+- **cli.py**:
+  - Made `database`, `collection`, and `command` arguments optional
+  - Added `-l`/`--list` flag for hierarchical listing
+  - Added `databases` and `collections` to command choices
+  - Added `import` command with stdin reading and error handling
+  - Implemented smart command routing for discovery vs CRUD
+  - Updated help text with discovery and import examples
+
+- **setup.py** & **pyproject.toml**:
+  - Added `jb` and `yb` console script entry points
+
+### Added Files
+- **demo.sh**: Comprehensive demo script showcasing all features
+- **CHANGELOG.md**: This file
+
+### TODO Before Release
+
+#### High Priority
+- [ ] Add pytest test suite
+- [ ] Add input validation (database/collection names)
+- [ ] Prevent path traversal vulnerabilities
+
+#### Medium Priority
+- [ ] Shell completion scripts (bash/zsh)
+- [ ] Add `--version` flag
+- [ ] More comprehensive error messages
+
+#### Nice to Have
+- [ ] Batch operations (set-many, del-many)
+- [ ] Query/filter capabilities
+- [ ] Backup/export entire database
+
+---
+
+## Version History
+
+### [0.1.0] - 2026-02-09 (Pre-release)
+Initial pre-release with core features and hierarchical discovery.
+
+**Note**: This version is feature-complete for core functionality but lacks:
+- stdin import command (documented but not implemented)
+- Test suite
+- Input validation
+
+Once these are added, this will be promoted to official 0.1.0 release.

nobox-0.1.0/CLAUDE.md

@@ -0,0 +1,203 @@
+# NoBox Project
+
+## Project Overview
+NoBox - JSON and YAML key-value storage utilities for flexible, schema-less data storage via CLI.
+
+Part of the [Box Suite](https://github.com/jmmirabile/confbox) - a modular Python CLI utility framework.
+
+## Project Structure
+```
+nobox/
+├── nobox/
+│   ├── __init__.py
+│   ├── drivers.py       # Driver base class, JSONDriver, YAMLDriver
+│   ├── store.py         # DictStore - CRUD operations
+│   ├── cli.py           # CLI command parser and executor
+│   └── main.py          # Entry points for jsonbox/yamlbox
+├── tests/
+├── docs/
+├── setup.py
+├── pyproject.toml
+├── README.md
+├── DESIGN.md            # Complete architecture and design decisions
+├── CLAUDE.md            # This file - project context
+└── LICENSE
+```
+
+## Commands Provided
+
+**Installation:**
+```bash
+pip install nobox
+```
+
+**Provides two commands:**
+- `jsonbox` (alias: `jb`) - JSON format storage
+- `yamlbox` (alias: `yb`) - YAML format storage
+
+## Quick Reference
+
+```bash
+# Discovery (hierarchical navigation)
+jb --list                      # List all databases (or jb -l, jb databases)
+jb mydb --list                 # List collections in mydb (or jb mydb -l)
+
+# CRUD operations
+jb mydb users set alice name:Alice age:30  # Set record
+jb mydb users get alice                    # Get record
+jb mydb users keys                         # List keys
+jb mydb users all                          # Show all records
+jb mydb users del alice                    # Delete record
+
+# Output formats
+jb mydb users all --json       # JSON object
+jb mydb users all --jsonl      # JSON Lines
+jb mydb users all --oneline    # key field:value format
+jb mydb users all --csv        # CSV for Excel
+
+# Import from stdin
+cat data.txt | jb mydb users import          # Bulk import records
+echo "alice name:Alice age:30" | jb mydb users import  # Single record
+```
+
+## Storage Location
+
+Uses ConfBox for cross-platform directories:
+
+| OS | Storage Location |
+|----|------------------|
+| Linux | `~/.local/share/nobox/` |
+| macOS | `~/Library/Application Support/nobox/` |
+| Windows | `%APPDATA%\nobox\` |
+
+**Structure:**
+```
+~/.local/share/nobox/
+├── json/              # JSON format storage
+│   └── mydb/          # Database (directory)
+│       ├── users.json # Collection (file)
+│       └── products.json
+└── yaml/              # YAML format storage
+    └── mydb/          # Same database, YAML format
+        ├── users.yaml
+        └── products.yaml
+```
+
+**Benefits:**
+- Single storage location (easier to backup)
+- Both formats can coexist for same database
+- Easy migration between formats (export/import)
+
+## Development Information
+
+### Build Commands
+```bash
+pip install -e .               # Development install
+pip install -e ".[dev]"        # With dev dependencies
+```
+
+### Test Commands
+```bash
+pytest                         # Run all tests
+pytest -v                      # Verbose output
+pytest tests/test_drivers.py   # Specific test file
+```
+
+### Lint Commands
+```bash
+# TBD - will add flake8, black, mypy
+```
+
+## Dependencies
+
+- **Python 3.8+**
+- **confbox** >= 0.1.0 - Cross-platform directory management
+- **PyYAML** - YAML format support (for yamlbox)
+
+## Key Design Decisions
+
+1. **Single package, two entry points** - DRY principle, shared code (jsonbox/jb, yamlbox/yb)
+2. **Pluggable drivers** - JSONDriver, YAMLDriver (could add TOML, etc.)
+3. **Schema-less** - Flexible key:value storage, complements DBBox
+4. **Multiple output formats** - Unix pipeline friendly (--json, --csv, --oneline, --jsonl)
+5. **Directory = Database** - Don't load entire DB for one collection
+6. **Hierarchical discovery** - Intuitive navigation from databases → collections → keys → records
+7. **Case-insensitive keys** - All keys stored lowercase for consistency
+
+## Use Cases
+
+- Network device configuration snapshots (F5, switches, routers)
+- API response caching
+- Operational data storage (server inventories, etc.)
+- Quick data capture (notes, todos, scratch data)
+- Any nested/complex data that's awkward in flat files
+
+## Related Projects
+
+### Box Suite
+- **[ConfBox](https://pypi.org/project/confbox/)** ✅ - Config management (published)
+- **[DBBox](https://github.com/jmmirabile/dbbox)** ✅ - SQLite utility (complete)
+- **NoBox** 🔨 - This project
+- **PlugBox** 🔨 - Plugin system (planned)
+- **CLIBox** 🔨 - CLI framework (planned)
+- **APIBox** 🔨 - API testing tool (planned)
+
+### Comparison: DBBox vs NoBox
+
+**Use DBBox when:**
+- Structured, relational data
+- Fixed schema
+- SQL queries needed
+- Flat tabular data
+
+**Use NoBox when:**
+- Nested, complex data structures
+- Variable/flexible fields
+- No schema needed
+- JSON/YAML natural format
+
+## Development Status
+
+- **Current Phase:** Core complete, ready for testing
+- **Version:** 0.1.0 (pre-release)
+- **Status:** Core features implemented, needs testing before release
+
+### Completed ✅
+- [x] Driver architecture (JSON, YAML)
+- [x] DictStore with CRUD operations
+- [x] CLI with all commands (set, get, del, keys, all, import)
+- [x] Multiple output formats (table, JSON, JSONL, oneline, CSV)
+- [x] Hierarchical discovery (databases, collections listing)
+- [x] Command aliases (jb, yb)
+- [x] Import from stdin with error handling
+- [x] Comprehensive documentation (README, DESIGN, examples)
+- [x] Cross-platform storage via ConfBox
+
+### TODO Before Release 📝
+1. **High Priority:**
+   - [ ] Add pytest test suite (tests/ directory exists but empty)
+   - [ ] Input validation (database/collection names, prevent path traversal)
+
+2. **Medium Priority:**
+   - [ ] Shell completion scripts (bash/zsh)
+   - [ ] Add --version flag
+   - [ ] More comprehensive error messages
+
+3. **Nice to Have:**
+   - [ ] Batch operations (set-many, del-many)
+   - [ ] Query/filter capabilities
+   - [ ] Backup/export entire database
+
+## Notes
+
+- See DESIGN.md for complete architecture documentation
+- Single user tool - no concurrent access handling
+- Complements DBBox (schema-less vs schema-based)
+- Part of Box Suite ecosystem
+- Follows Box Suite principles: modular, independent, complementary, professional
+
+---
+
+**Project Started:** 2026-02-06
+**Working Directory:** /home/jeffmira/Documents/dev/nobox
+**Git Repository:** Not yet initialized