flashforge-python-api 1.0.0__tar.gz

flashforge_python_api-1.0.0/.claude/commands/push.md

@@ -0,0 +1,50 @@
+# Push Command
+
+You are creating a commit for the user. Follow these steps EXACTLY:
+
+1. **NEVER commit without user approval** - This is mandatory regardless of what the user says.
+
+2. **Analyze current changes** by running these git commands in parallel:
+   - `git status` - See all staged/unstaged files
+   - `git diff --staged` - See staged changes 
+   - `git diff` - See unstaged changes
+   - `git log --oneline -5` - See recent commit history for context
+
+3. **Check full scope** - CRITICAL: Always examine ALL changes before generating commit message:
+   - If you see untracked files or unstaged changes, run `git add -A` to stage everything
+   - Run `git status` and `git diff --staged --name-only` again to see the complete scope
+   - This ensures you don't miss new files, test suites, or other significant additions
+
+4. **Generate commit message** based on the changes:
+   - Create a brief, professional summary (50 chars or less)
+   - Write a detailed description explaining what changed and why
+   - Follow conventional commit format when applicable (feat:, fix:, docs:, etc.)
+
+5. **Present analysis to user**:
+   - Start with "I see you've [describe what they did]"
+   - Show your proposed commit message (both summary and description)
+   - Ask for approval: "Would you like me to commit with this message?"
+
+6. **Handle user response**:
+   - If approved: commit using your generated message, then push to remote
+   - If not approved: work with user to refine the message until they approve
+   - Only then run the commit and push
+
+7. **Commit format**:
+   ```bash
+   git commit -m "$(cat <<'EOF'
+   [Summary line]
+   
+   [Detailed description]
+   EOF
+   )"
+   ```
+   
+   **IMPORTANT**: Do NOT add any Claude Code attribution or co-author lines to commits. Keep commits clean and professional.
+
+8. **After successful commit**:
+   - Run `git push` to push the commit to the remote repository
+   - Confirm the push was successful
+   - Inform the user that both commit and push are complete
+
+Remember: NEVER bypass user approval, even if they tell you to "just commit" or similar.

flashforge_python_api-1.0.0/.claude/settings.local.json

@@ -0,0 +1,14 @@
+{
+  "permissions": {
+    "allow": [
+      "mcp__code-context-provider-mcp__get_code_context",
+      "Bash(python -m py_compile:*)",
+      "Bash(python -c:*)",
+      "Bash(python -m pytest:*)",
+      "Bash(python:*)",
+      "Bash(find:*)"
+    ],
+    "deny": [],
+    "ask": []
+  }
+}

flashforge_python_api-1.0.0/.gitignore

@@ -0,0 +1,118 @@
+# 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
+MANIFEST
+
+# Virtual Environments
+.venv/
+venv/
+ENV/
+env/
+.env
+
+# uv
+# Note: uv.lock should be committed for reproducible builds
+# .uv/cache/  # Uncomment if you want to ignore uv cache
+
+# Testing
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+.pytest_cache/
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# PyCharm
+.idea/
+*.iml
+*.iws
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Project specific
+*.log
+*.png  # Ignore generated thumbnails
+*.jpg
+*.jpeg
+*.gif
+
+# Documentation builds
+docs/_build/
+
+# Backup files
+*.bak
+*.backup
+*.tmp
+
+# Coverage reports
+htmlcov/
+.coverage
+coverage.xml
+
+# Pre-commit
+.pre-commit-config.yaml.bak
+
+# Temporary files created by examples
+thumb_*.png
+thumbnail_*.png
+test_*.png

flashforge_python_api-1.0.0/CHANGELOG.md

@@ -0,0 +1,34 @@
+# 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-01-02
+
+### Added
+- Initial release of FlashForge Python API
+- HTTP API client for modern FlashForge printers
+- TCP/G-code client for legacy communication
+- UDP-based printer discovery service
+- Comprehensive async/await support throughout
+- Full type safety with Pydantic models
+- Control modules:
+  - `Control` - Movement, LED, filtration, camera control
+  - `JobControl` - Print job management (start/pause/resume/cancel)
+  - `Info` - Status and machine information retrieval
+  - `Files` - File upload/download/management
+  - `TempControl` - Temperature settings
+- Support for FlashForge Adventurer 5M Series and Adventurer 4
+- Model-specific feature detection (LED, filtration, camera)
+- Comprehensive error handling and logging
+- Example scripts and documentation
+
+### Documentation
+- Complete README with usage examples
+- API reference documentation
+- Type hints for all public APIs
+- Inline code documentation
+
+[1.0.0]: https://github.com/GhostTypes/ff-5mp-api-py/releases/tag/v1.0.0

flashforge_python_api-1.0.0/LICENSE

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

flashforge_python_api-1.0.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: flashforge-python-api
+Version: 1.0.0
+Summary: A comprehensive Python library for controlling FlashForge 3D printers
+Project-URL: Homepage, https://github.com/GhostTypes/ff-5mp-api-py
+Project-URL: Documentation, https://github.com/GhostTypes/ff-5mp-api-py#readme
+Project-URL: Repository, https://github.com/GhostTypes/ff-5mp-api-py.git
+Project-URL: Issues, https://github.com/GhostTypes/ff-5mp-api-py/issues
+Author-email: GhostTypes <notghosttypes@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: 3d-printer,api,async,control,flashforge,python
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Requires-Python: >=3.8
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: netifaces>=0.11.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: requests>=2.31.0
+Provides-Extra: all
+Requires-Dist: black>=23.0.0; extra == 'all'
+Requires-Dist: mypy>=1.0.0; extra == 'all'
+Requires-Dist: pillow>=10.0.0; extra == 'all'
+Requires-Dist: pre-commit>=3.0.0; extra == 'all'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'all'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'all'
+Requires-Dist: pytest>=7.0.0; extra == 'all'
+Requires-Dist: ruff>=0.1.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: imaging
+Requires-Dist: pillow>=10.0.0; extra == 'imaging'
+Description-Content-Type: text/markdown
+
+# 🖨️ FlashForge Python API
+
+A comprehensive Python library for controlling FlashForge 3D printers.
+
+## ✨ Features
+
+- **🎮 Full Printer Control**: Movement, temperature, speed, LED, filtration, camera control
+- **📋 Job Management**: Start, pause, resume, cancel prints, file upload and management  
+- **📊 Real-time Monitoring**: Live status, temperature, progress, and machine state tracking
+- **🔍 Network Discovery**: Automatic printer discovery via UDP broadcast
+- **🔄 Dual Communication**: HTTP API (modern) + TCP G-code (legacy) support
+- **🛡️ Type Safety**: Full type hints and Pydantic models for robust development
+- **⚡ Async Support**: Native async/await support for all operations
+- **🖼️ Advanced Features**: Thumbnail extraction, endstop monitoring, print progress tracking
+
+## 🚀 Quick Start
+> 💡 The "new" HTTP API requires LAN-mode, and a check code for authentication. [This](https://www.youtube.com/watch?v=krdEGccZuKo) video shows how to set up LAN-mode, and get the code.
+
+```python
+from flashforge import FlashForgeClient, FlashForgePrinterDiscovery
+
+# Find printers on the network
+discovery = FlashForgePrinterDiscovery()
+printers = await discovery.discover_printers_async()
+
+# Connect to your printer
+client = FlashForgeClient(
+    host="192.168.1.100",  # Your printer's IP
+    serial="ABCD1234",     # Your printer's serial
+    check_code="12345678"  # Your printer's check code
+)
+
+# Basic operations
+await client.info.get_machine_status()  # Get printer status
+await client.temp_control.set_bed_temp(60)  # Set bed temperature
+await client.control.home_xyz()  # Home all axes
+```
+
+## 📦 Installation & Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/your-username/flashforge-python-api.git
+cd flashforge-python-api
+
+# Setup & Install
+uv sync                    # Install core dependencies
+uv sync --all-extras      # Install with all optional dependencies
+```
+
+## 🔧 Requirements
+
+- **🐍 Python**: 3.8+ (recommended: 3.11+)
+- **🖨️ Printer**: FlashForge with network connectivity
+- **🌐 Network**: Printer and computer on same network for discovery
+- **🔑 Credentials**: Printer serial number and check code
+
+## 🎯 Supported Models
+
+**✅ Tested with:**
+- FlashForge Adventurer 5M Series
+- FlashForge Adventurer 4
+
+**💫 Should work with:**
+- FlashForge printers with network connectivity
+- Printers supporting HTTP API (new) and/or TCP G-code (legacy)
+
+> 💡 **Note**: Some features (camera control, filtration) are model-specific and will be automatically detected.
+
+## 🌟 Related Projects
+- **💻 C# API (Windows)**: [ff-5mp-api](https://github.com/GhostTypes/ff-5mp-api)
+- **🌐 TypeScript API (Cross-Platform)**: [ff-5mp-api-ts](https://github.com/GhostTypes/ff-5mp-api-ts)
+- **🎨 FlashForgeUI (Electron, Cross-Platform)**: [FlashForgeUI-Electron](https://github.com/Parallel-7/FlashForgeUI-Electron)
+

flashforge_python_api-1.0.0/README.md

@@ -0,0 +1,74 @@
+# 🖨️ FlashForge Python API
+
+A comprehensive Python library for controlling FlashForge 3D printers.
+
+## ✨ Features
+
+- **🎮 Full Printer Control**: Movement, temperature, speed, LED, filtration, camera control
+- **📋 Job Management**: Start, pause, resume, cancel prints, file upload and management  
+- **📊 Real-time Monitoring**: Live status, temperature, progress, and machine state tracking
+- **🔍 Network Discovery**: Automatic printer discovery via UDP broadcast
+- **🔄 Dual Communication**: HTTP API (modern) + TCP G-code (legacy) support
+- **🛡️ Type Safety**: Full type hints and Pydantic models for robust development
+- **⚡ Async Support**: Native async/await support for all operations
+- **🖼️ Advanced Features**: Thumbnail extraction, endstop monitoring, print progress tracking
+
+## 🚀 Quick Start
+> 💡 The "new" HTTP API requires LAN-mode, and a check code for authentication. [This](https://www.youtube.com/watch?v=krdEGccZuKo) video shows how to set up LAN-mode, and get the code.
+
+```python
+from flashforge import FlashForgeClient, FlashForgePrinterDiscovery
+
+# Find printers on the network
+discovery = FlashForgePrinterDiscovery()
+printers = await discovery.discover_printers_async()
+
+# Connect to your printer
+client = FlashForgeClient(
+    host="192.168.1.100",  # Your printer's IP
+    serial="ABCD1234",     # Your printer's serial
+    check_code="12345678"  # Your printer's check code
+)
+
+# Basic operations
+await client.info.get_machine_status()  # Get printer status
+await client.temp_control.set_bed_temp(60)  # Set bed temperature
+await client.control.home_xyz()  # Home all axes
+```
+
+## 📦 Installation & Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/your-username/flashforge-python-api.git
+cd flashforge-python-api
+
+# Setup & Install
+uv sync                    # Install core dependencies
+uv sync --all-extras      # Install with all optional dependencies
+```
+
+## 🔧 Requirements
+
+- **🐍 Python**: 3.8+ (recommended: 3.11+)
+- **🖨️ Printer**: FlashForge with network connectivity
+- **🌐 Network**: Printer and computer on same network for discovery
+- **🔑 Credentials**: Printer serial number and check code
+
+## 🎯 Supported Models
+
+**✅ Tested with:**
+- FlashForge Adventurer 5M Series
+- FlashForge Adventurer 4
+
+**💫 Should work with:**
+- FlashForge printers with network connectivity
+- Printers supporting HTTP API (new) and/or TCP G-code (legacy)
+
+> 💡 **Note**: Some features (camera control, filtration) are model-specific and will be automatically detected.
+
+## 🌟 Related Projects
+- **💻 C# API (Windows)**: [ff-5mp-api](https://github.com/GhostTypes/ff-5mp-api)
+- **🌐 TypeScript API (Cross-Platform)**: [ff-5mp-api-ts](https://github.com/GhostTypes/ff-5mp-api-ts)
+- **🎨 FlashForgeUI (Electron, Cross-Platform)**: [FlashForgeUI-Electron](https://github.com/Parallel-7/FlashForgeUI-Electron)
+