supynote 0.8.0__tar.gz

supynote-0.8.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: Bug Report
+about: Report a bug or unexpected behavior
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+## Describe the Bug
+A clear and concise description of what the bug is.
+
+## To Reproduce
+Steps to reproduce the behavior:
+1. Run command '...'
+2. See error '...'
+
+## Expected Behavior
+A clear and concise description of what you expected to happen.
+
+## Environment
+- OS: [e.g., macOS 14.0, Ubuntu 22.04, Windows 11]
+- Python version: [e.g., 3.11.5]
+- supynote-cli version: [e.g., 1.0.0]
+- Supernote Device: [e.g., A5X, A6X, Nomad]
+- Installation method: [pip, uv, from source]
+
+## Logs/Error Messages
+```
+Paste error messages or relevant logs here
+```
+
+## Additional Context
+Add any other context about the problem here. Screenshots can be helpful for UI-related issues.
+
+## Possible Solution (Optional)
+If you have ideas on how to fix this, please share them here.

supynote-0.8.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,31 @@
+---
+name: Feature Request
+about: Suggest a new feature or enhancement
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+---
+
+## Feature Description
+A clear and concise description of the feature you'd like to see.
+
+## Use Case
+Explain how this feature would be used and why it's valuable. What problem does it solve?
+
+## Proposed Solution
+If you have ideas on how to implement this feature, share them here. Include:
+- API/CLI interface design
+- Expected behavior
+- Configuration options (if applicable)
+
+## Alternatives Considered
+Describe any alternative solutions or features you've considered.
+
+## Additional Context
+Add any other context, screenshots, or examples about the feature request here.
+
+## Would you be willing to contribute this feature?
+- [ ] Yes, I'd like to implement this
+- [ ] Yes, with guidance
+- [ ] No, but I'd be happy to test it
+- [ ] Just suggesting

supynote-0.8.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,40 @@
+## Description
+Brief description of changes made in this PR.
+
+Fixes #(issue number)
+
+## Type of Change
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Code refactoring
+- [ ] Performance improvement
+- [ ] Other (please describe)
+
+## Testing
+- [ ] Tests added/updated for new functionality
+- [ ] All tests pass locally (`pytest`)
+- [ ] Manually tested the changes
+- [ ] Tested on multiple Python versions (if applicable)
+- [ ] Tested with actual Supernote device (if applicable)
+
+## Documentation
+- [ ] Code documentation (docstrings) added/updated
+- [ ] README updated (if needed)
+- [ ] CHANGELOG.md updated
+- [ ] Examples added/updated (if applicable)
+
+## Checklist
+- [ ] Code follows project style guidelines (PEP 8)
+- [ ] Self-reviewed my own code
+- [ ] Commented code in hard-to-understand areas
+- [ ] No new warnings introduced
+- [ ] Commit messages are clear and descriptive
+- [ ] No personal data or credentials in code
+
+## Screenshots (if applicable)
+Add screenshots or terminal output to help explain your changes.
+
+## Additional Notes
+Any additional information that reviewers should know about this PR.

supynote-0.8.0/.github/workflows/ci.yml

@@ -0,0 +1,61 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install uv
+      run: pip install uv
+
+    - name: Install dependencies
+      run: |
+        uv sync
+        pip install -e .
+
+    - name: Run tests
+      run: pytest tests/ -v --tb=short
+
+    - name: Check code formatting (Python 3.11 only)
+      if: matrix.python-version == '3.11'
+      run: |
+        pip install black
+        black --check supynote/ || echo "Code formatting check skipped"
+
+  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 linting tools
+      run: |
+        pip install flake8
+
+    - name: Lint with flake8
+      run: |
+        # Stop the build if there are Python syntax errors or undefined names
+        flake8 supynote/ --count --select=E9,F63,F7,F82 --show-source --statistics
+        # Exit-zero treats all errors as warnings
+        flake8 supynote/ --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

supynote-0.8.0/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for trusted publishing to PyPI
+      contents: read
+
+    steps:
+      - name: Checkout code
+        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: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true

supynote-0.8.0/.gitignore

@@ -0,0 +1,187 @@
+# 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/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.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/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Personal configuration
+.claude/settings.local.json
+.claude/*.local.json
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be added to the global gitignore or merged into this project gitignore.  For a PyCharm
+#  project, please select 'PyCharm Community' from the 'Select gitignore template' option.
+#  See https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+.idea/
+
+# VS Code
+.vscode/
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Windows
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+
+data/
+
+*.swp
+*.plist
+
+# Examples - local configurations
+examples/automation/.env
+examples/automation/*.plist
+examples/**/*.swp

supynote-0.8.0/CHANGELOG.md

@@ -0,0 +1,65 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2025-12-05
+
+### Initial Release
+
+This is the first public release of supynote-cli, a command-line tool for interacting with Supernote e-ink tablets over local network.
+
+#### Features
+- **Device Discovery**: Auto-discovery of Supernote devices on local network
+- **File Management**: List and browse files on device
+- **High-Performance Downloads**: Parallel async downloads with configurable workers (20-30x faster than sync)
+- **PDF Conversion**: Convert .note files to high-quality vector PDFs using supernotelib
+- **OCR Support**: Multiple OCR engines for handwritten text recognition
+  - Native text extraction (default, fast)
+  - TrOCR (Microsoft, handwriting-optimized)
+  - LLaVA (via Ollama, advanced)
+  - Gemini API integration
+- **Date-Based Merging**: Automatically merge PDFs by date with markdown generation
+- **Apple Silicon Support**: MPS acceleration for OCR on M1/M2/M3/M4 Macs
+- **CLI Commands**: find, list, download, convert, ocr, merge, browse, info, validate
+
+#### Architecture
+- Domain-Driven Design (DDD) layered architecture
+- Separation of concerns: domain, application, infrastructure, presentation layers
+- Repository pattern for data access
+- Use case driven design
+- Type hints throughout codebase
+
+#### Performance
+- Async HTTP with connection pooling and keep-alive
+- Configurable worker concurrency for downloads and conversions
+- Streaming file I/O for memory efficiency with large files
+- Parallel PDF conversion with ThreadPoolExecutor
+- Smart file size checking to skip unnecessary downloads
+
+#### Documentation
+- Comprehensive README with installation, usage, and troubleshooting
+- Example automation scripts for Alfred (macOS) and remote sync
+- Contributing guidelines and Code of Conduct
+- GitHub issue and PR templates
+- CI/CD with GitHub Actions
+
+#### Developer Experience
+- Modern Python tooling with uv support
+- Optional dependencies for OCR features
+- Comprehensive test suite (unit and integration)
+- Pre-commit hooks compatible
+- Multiple Python version support (3.8-3.12)
+
+### Security
+- No hardcoded credentials or personal data
+- Environment variable support for configuration
+- Secure network communication over local network only
+
+---
+
+## Future Releases
+
+See [GitHub Issues](https://github.com/r4tb/supynote-cli/issues) for planned features and improvements.

supynote-0.8.0/CLAUDE.md

@@ -0,0 +1,89 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Development Commands
+
+### Installation and Setup
+```bash
+# Install with uv (recommended)
+uv sync
+pip install -e .
+
+# Or with pip
+pip install -e .
+```
+
+### Testing the CLI
+```bash
+# Run the CLI directly
+python -m supynote.cli find
+supynote find
+
+# Test specific commands
+supynote list
+supynote download Note
+supynote download Note --async --workers 30  # High-performance async download
+supynote download Note --convert-pdf --workers 20 --conversion-workers 8  # Parallel download + conversion
+supynote convert Note/ --workers 8  # Parallel PDF conversion
+supynote convert file.note
+```
+
+## Code Architecture
+
+This is a Python CLI tool for interacting with Supernote e-ink tablet devices over the local network.
+
+### Core Components
+
+**CLI Entry Point (`cli.py:main`)**
+- Main command parser using argparse with subcommands: find, list, download, convert, browse, info
+- Handles global options: --ip, --port, --output
+- Device discovery via `find_device()` before most operations
+
+**Device Interface (`supernote.py:Supernote`)**
+- Core class for device communication via HTTP requests
+- Methods: `list_files()`, `download_file()`, `download_directory()`, `get_device_info()`
+- **High-performance async methods**: `download_directory_async()` with connection pooling and semaphore-controlled concurrency
+- Uses BeautifulSoup to parse device web interface HTML and extract JSON data
+- Supports both multithreaded (sync) and async/await (high-performance) downloads
+- Async version uses aiohttp with TCP connection pooling, keep-alive, and streaming file I/O
+
+**Network Discovery (`device_finder.py`)**
+- Scans local /24 network for devices listening on port 8089
+- Uses concurrent socket connections for fast network scanning
+- Function: `find_device()` returns IP address or None
+
+**PDF Conversion (`converter.py:PDFConverter`)**
+- Converts Supernote .note files to PDF using `supernotelib` dependency
+- **Parallel processing**: `convert_directory()` with ThreadPoolExecutor for batch conversions
+- Supports vector (high-quality) and raster formats
+- Options for hyperlinks, recursive directory processing
+- Methods: `convert_file()`, `convert_directory()`, `convert_files_batch()`
+
+### Data Flow
+
+1. **Device Discovery**: CLI → `find_device()` → network scan → IP address
+2. **File Operations**: CLI → `Supernote(ip)` → HTTP requests → device web interface
+3. **Downloads**: Device listing → parallel file downloads → local filesystem
+4. **Conversion**: Local .note files → `supernotelib` → PDF output
+
+### Key Dependencies
+
+- `requests` + `beautifulsoup4`: Device HTTP communication and HTML parsing
+- `aiohttp` + `aiofiles`: High-performance async HTTP with connection pooling (optional but recommended)
+- `supernotelib>=0.6.0`: Proprietary .note file format conversion to PDF
+- Built-in: `concurrent.futures`, `pathlib`, `argparse`, `asyncio`
+
+### Performance Notes
+
+- **Default async mode**: Downloads use async by default with 20 concurrent connections
+- **Connection pooling**: Async version reuses HTTP connections for better performance
+- **Memory efficient streaming**: Large files are streamed to disk rather than loaded into memory
+- **Configurable concurrency**: Use `--workers N` to control concurrent download limit
+
+### File Structure Patterns
+
+- Downloads default to `./data/` directory
+- Maintains remote directory structure in local downloads
+- PDF conversion preserves relative paths when processing directories
+- All paths use `pathlib.Path` for cross-platform compatibility

supynote-0.8.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement via GitHub issues.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations