winebox 0.1.0__tar.gz

winebox-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,83 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Tesseract OCR
+        run: sudo apt-get update && sudo apt-get install -y tesseract-ocr
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run tests
+        run: uv run pytest -v
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Check import sorting with isort
+        run: uv run pip install isort && uv run isort --check-only --diff winebox tests
+        continue-on-error: true
+
+  build:
+    name: Build package
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package
+        run: |
+          pip install twine
+          twine check dist/*

winebox-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,74 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Store distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/winebox
+    permissions:
+      id-token: write  # Required for trusted publishing
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/winebox
+    permissions:
+      id-token: write  # Required for trusted publishing
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

winebox-0.1.0/.gitignore

@@ -0,0 +1,62 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# Data (local database and images)
+data/
+*.db
+
+# Environment variables
+.env
+.env.local
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Sphinx documentation
+docs/_build/
+
+# Logs
+*.log
+
+# Temporary files
+tmp/
+temp/

winebox-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11

winebox-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Joe Drumgoole
+
+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.

winebox-0.1.0/PKG-INFO

@@ -0,0 +1,283 @@
+Metadata-Version: 2.4
+Name: winebox
+Version: 0.1.0
+Summary: Wine Cellar Management Application with OCR label scanning
+Project-URL: Homepage, https://github.com/jdrumgoole/winebox
+Project-URL: Repository, https://github.com/jdrumgoole/winebox
+Project-URL: Issues, https://github.com/jdrumgoole/winebox/issues
+Author-email: Joe Drumgoole <joe@joedrumgoole.com>
+License: MIT
+License-File: LICENSE
+Keywords: cellar,fastapi,inventory,ocr,wine
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: End Users/Desktop
+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: Topic :: Home Automation
+Requires-Python: >=3.11
+Requires-Dist: aiofiles>=23.0.0
+Requires-Dist: aiosqlite>=0.19.0
+Requires-Dist: bcrypt<4.1.0,>=4.0.0
+Requires-Dist: fastapi>=0.109.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: passlib>=1.7.4
+Requires-Dist: pillow>=10.0.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pytesseract>=0.3.10
+Requires-Dist: python-jose[cryptography]>=3.3.0
+Requires-Dist: python-multipart>=0.0.6
+Requires-Dist: sqlalchemy>=2.0.0
+Requires-Dist: uvicorn[standard]>=0.27.0
+Provides-Extra: dev
+Requires-Dist: greenlet>=3.0.0; extra == 'dev'
+Requires-Dist: httpx>=0.26.0; extra == 'dev'
+Requires-Dist: invoke>=2.2.0; extra == 'dev'
+Requires-Dist: myst-parser>=2.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: sphinx>=7.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# WineBox
+
+A wine cellar management application with OCR label scanning.
+
+## Features
+
+- **Label Scanning**: Upload wine label images for automatic text extraction via OCR
+- **Inventory Tracking**: Check-in and check-out bottles with full history
+- **Smart Parsing**: Automatically identifies vintage, grape variety, region, and more
+- **Search**: Find wines by any criteria
+- **Web Interface**: Simple, mobile-friendly interface
+
+## Quick Start
+
+### Prerequisites
+
+- Python 3.11+
+- [Tesseract OCR](https://github.com/tesseract-ocr/tesseract)
+
+### Installation
+
+**From PyPI:**
+```bash
+pip install winebox
+```
+
+**From source:**
+```bash
+# Clone the repository
+git clone https://github.com/jdrumgoole/winebox.git
+cd winebox
+
+# Install dependencies
+uv sync --all-extras
+
+# Install Tesseract OCR
+# macOS:
+brew install tesseract
+
+# Ubuntu/Debian:
+sudo apt-get install tesseract-ocr
+```
+
+### Running the Server
+
+```bash
+# Development mode with auto-reload
+invoke start --reload
+
+# Background mode
+invoke start-background
+
+# Check status
+invoke status
+
+# Stop server
+invoke stop
+```
+
+### Access the Application
+
+- **Web Interface**: http://localhost:8000/static/index.html
+- **API Documentation**: http://localhost:8000/docs
+- **Health Check**: http://localhost:8000/health
+
+## Usage
+
+### Check In Wine
+
+1. Navigate to the Check In page
+2. Upload front label image (required)
+3. Optionally upload back label image
+4. Review/edit auto-detected wine details
+5. Set quantity and add notes
+6. Click "Check In Wine"
+
+### Check Out Wine
+
+1. Go to the Cellar view
+2. Click "Check Out" on a wine card
+3. Enter quantity to remove
+4. Add optional notes (tasting notes, occasion)
+5. Confirm checkout
+
+### Search
+
+Use the Search page to find wines by:
+- Text search (name, winery, region)
+- Vintage year
+- Grape variety
+- Region or country
+- Stock status
+
+## API
+
+Full REST API available at `/api`:
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/api/wines/checkin` | POST | Add wine to cellar |
+| `/api/wines/{id}/checkout` | POST | Remove wine from cellar |
+| `/api/wines` | GET | List all wines |
+| `/api/wines/{id}` | GET | Get wine details |
+| `/api/cellar` | GET | Current inventory |
+| `/api/cellar/summary` | GET | Cellar statistics |
+| `/api/transactions` | GET | Transaction history |
+| `/api/search` | GET | Search wines |
+
+See `/docs` for interactive API documentation.
+
+## Data Storage
+
+### Database
+
+The SQLite database is stored at `data/winebox.db` by default. This can be configured via the `WINEBOX_DATABASE_URL` environment variable.
+
+### Images
+
+Wine label images are stored in the `data/images/` directory by default. Each image is saved with a UUID filename to avoid conflicts.
+
+| Item | Default Location | Environment Variable |
+|------|------------------|---------------------|
+| Database | `data/winebox.db` | `WINEBOX_DATABASE_URL` |
+| Images | `data/images/` | `WINEBOX_IMAGE_STORAGE_PATH` |
+
+Images are served via the API at `/api/images/{filename}`.
+
+**Note:** The `data/` directory is excluded from git (see `.gitignore`). Make sure to back up this directory to preserve your wine collection data.
+
+## Authentication
+
+WineBox requires authentication for all API endpoints (except `/health`).
+
+### Creating Users
+
+Use the `winebox-admin` command to manage users:
+
+```bash
+# Create an admin user
+uv run winebox-admin add admin --email admin@example.com --admin --password yourpassword
+
+# Create a regular user
+uv run winebox-admin add username --email user@example.com --password yourpassword
+
+# List all users
+uv run winebox-admin list
+
+# Disable/enable a user
+uv run winebox-admin disable username
+uv run winebox-admin enable username
+
+# Change password
+uv run winebox-admin passwd username --password newpassword
+
+# Remove a user
+uv run winebox-admin remove username
+```
+
+### Server Management
+
+Use the `winebox-server` command to manage the server:
+
+```bash
+# Start server (foreground)
+uv run winebox-server start --foreground
+
+# Start server (background)
+uv run winebox-server start
+
+# Stop server
+uv run winebox-server stop
+
+# Restart server
+uv run winebox-server restart
+
+# Check status
+uv run winebox-server status
+```
+
+### API Authentication
+
+The API uses JWT bearer tokens. To authenticate:
+
+1. POST to `/api/auth/token` with `username` and `password` (form-urlencoded)
+2. Include the returned token in subsequent requests: `Authorization: Bearer <token>`
+
+Tokens expire after 24 hours.
+
+## Development
+
+### Running Tests
+
+```bash
+# Run all tests
+invoke test
+
+# With verbose output
+invoke test --verbose
+
+# With coverage
+invoke test --coverage
+```
+
+### Project Structure
+
+```
+winebox/
+├── winebox/          # Application package
+│   ├── main.py       # FastAPI app
+│   ├── models/       # Database models
+│   ├── schemas/      # API schemas
+│   ├── routers/      # API endpoints
+│   ├── services/     # Business logic
+│   └── static/       # Web interface
+├── tests/            # Test suite
+├── docs/             # Documentation
+└── tasks.py          # Build tasks
+```
+
+### Building Documentation
+
+```bash
+invoke docs-build
+invoke docs-serve
+```
+
+## Tech Stack
+
+- **FastAPI**: Web framework
+- **SQLAlchemy**: ORM
+- **SQLite**: Database
+- **Tesseract**: OCR engine
+- **Vanilla JS**: Frontend (no frameworks)
+
+## License
+
+MIT License