pumaguard 21.post27__py3-none-any.whl → 21.post83__py3-none-any.whl

pumaguard-ui/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pumaguard-ui/Makefile

@@ -0,0 +1,36 @@
+.PHONY: pre-commit
+pre-commit: version analyze format build
+
+.PHONY: analyze
+analyze: version
+	flutter analyze
+
+.PHONY: format
+format:
+	dart format lib
+
+.PHONY: version
+version:
+	@echo "Checking for git repository..."
+	@if git rev-parse --git-dir > /dev/null 2>&1; then \
+		echo "Generating version from git tags..."; \
+		VERSION=$$(git describe --tags --always --dirty 2>/dev/null || echo "v0.0.0-unknown"); \
+		echo "// This file is auto-generated. Do not edit manually." > lib/version.dart; \
+		echo "// Generated by: make version" >> lib/version.dart; \
+		echo "const String appVersion = '$$VERSION';" >> lib/version.dart; \
+		echo "Generated version: $$VERSION"; \
+	else \
+		echo "Not in a git repository - preserving existing version.dart"; \
+		if [ ! -f lib/version.dart ]; then \
+			echo "No version.dart found, creating with default version..."; \
+			echo "// This file is auto-generated. Do not edit manually." > lib/version.dart; \
+			echo "// Generated by: make version" >> lib/version.dart; \
+			echo "const String appVersion = 'v0.0.0-unknown';" >> lib/version.dart; \
+		else \
+			echo "Using existing version.dart"; \
+		fi; \
+	fi
+
+.PHONY: build
+build: version
+	flutter build web --wasm

pumaguard-ui/README.md

@@ -0,0 +1,371 @@
+# PumaGuard Web UI
+
+A modern Flutter web interface for monitoring and configuring the PumaGuard wildlife detection system.
+
+## Features
+
+- **Real-time Status Display**: View system status and monitoring information
+- **Settings Management**: Configure YOLO detection and EfficientNet classifier parameters
+- **Directory Management**: Add and remove image directories to monitor
+- **Responsive Design**: Works on desktop and mobile browsers
+- **Material Design 3**: Modern, clean UI with light/dark theme support
+
+## Screenshots
+
+### Home Screen
+
+- System status indicator
+- Quick access to settings and directories
+- System information display
+
+### Settings Screen
+
+- YOLO detection parameters (min size, confidence threshold, max detections)
+- Classifier model configuration
+- Sound deterrent settings
+- System behavior options
+
+### Directories Screen
+
+- List of monitored directories
+- Add/remove directories with confirmation
+- Empty state with helpful guidance
+
+## Prerequisites
+
+- Flutter SDK (3.10.0 or later)
+- Dart SDK (included with Flutter)
+- PumaGuard backend server running
+
+## Installation
+
+1. Install Flutter dependencies:
+
+   ```bash
+   cd web-ui-flutter
+   flutter pub get
+   ```
+
+2. Run code generation (if needed):
+   ```bash
+   flutter pub run build_runner build --delete-conflicting-outputs
+   ```
+
+## Development
+
+### Version Management
+
+The UI version is automatically generated from git tags. The version file `lib/version.dart` is auto-generated and should not be edited manually.
+
+To generate/update the version:
+
+```bash
+make version
+```
+
+This will read the current git tag (from `git describe --tags`) and update `lib/version.dart`.
+
+### Run in Development Mode
+
+Start the Flutter development server:
+
+```bash
+make version  # Generate version first
+flutter run -d chrome
+```
+
+Or for web server mode:
+
+```bash
+flutter run -d web-server --web-hostname=0.0.0.0 --web-port=8080
+```
+
+### Hot Reload
+
+When running in development mode, press `r` to hot reload or `R` to hot restart.
+
+## Building for Production
+
+### Build Web App
+
+The build process automatically generates the version from git tags:
+
+```bash
+make build  # This runs 'make version' then 'flutter build web --wasm'
+```
+
+Or manually:
+
+```bash
+flutter build web --release
+```
+
+The built files will be in `build/web/` directory.
+
+### Build Options
+
+For optimized builds:
+
+```bash
+# Build with web renderer
+flutter build web --web-renderer canvaskit
+
+# Build with HTML renderer (smaller size)
+flutter build web --web-renderer html
+
+# Build with auto-selection
+flutter build web --web-renderer auto
+```
+
+### Makefile Targets
+
+The project includes a Makefile for common development tasks:
+
+```bash
+make version      # Generate version.dart from git tags
+make analyze      # Run Flutter analyzer
+make format       # Format Dart code
+make build        # Build for production (includes version generation)
+make pre-commit   # Run all checks (analyze, format, build)
+```
+
+## Configuration
+
+### API Endpoint
+
+By default, the app connects to `http://localhost:5000`. To change this, modify the `ApiService` constructor in `lib/services/api_service.dart`:
+
+```dart
+ApiService({this.baseUrl = 'http://your-server:5000'});
+```
+
+Or set it at runtime when creating the provider in `lib/main.dart`:
+
+```dart
+Provider<ApiService>(
+  create: (_) => ApiService(baseUrl: 'http://your-server:5000'),
+  // ...
+)
+```
+
+## Project Structure
+
+```
+lib/
+├── main.dart                    # App entry point
+├── models/                      # Data models
+│   ├── status.dart              # System status model
+│   └── settings.dart            # Settings model
+├── screens/                     # UI screens
+│   ├── home_screen.dart         # Main dashboard
+│   ├── settings_screen.dart    # Settings configuration
+│   └── directories_screen.dart # Directory management
+├── services/                    # API services
+│   └── api_service.dart         # Backend API client
+└── widgets/                     # Reusable widgets
+```
+
+## API Integration
+
+The Flutter app communicates with the PumaGuard backend via REST API:
+
+- `GET /api/status` - Get system status
+- `GET /api/settings` - Get current settings
+- `PUT /api/settings` - Update settings
+- `POST /api/settings/save` - Save settings to file
+- `POST /api/settings/load` - Load settings from file
+- `GET /api/directories` - Get monitored directories
+- `POST /api/directories` - Add directory
+- `DELETE /api/directories/:index` - Remove directory
+
+## Starting the Backend
+
+Before using the web UI, start the PumaGuard backend server:
+
+```bash
+# From the project root
+python -m pumaguard.web_ui --host 0.0.0.0 --port 5000
+```
+
+With settings and image directories:
+
+```bash
+python -m pumaguard.web_ui \
+  --host 0.0.0.0 \
+  --port 5000 \
+  --settings settings.yaml \
+  --image-dir /path/to/images1 \
+  --image-dir /path/to/images2
+```
+
+## Deployment
+
+### Option 1: Serve with Backend
+
+The PumaGuard backend automatically serves the built Flutter web app from `web-ui-flutter/build/web/`.
+
+1. Build the Flutter app:
+
+   ```bash
+   cd web-ui-flutter
+   flutter build web --release
+   ```
+
+2. Start the backend server:
+
+   ```bash
+   cd ..
+   python -m pumaguard.web_ui --host 0.0.0.0 --port 5000
+   ```
+
+3. Access the UI at `http://localhost:5000`
+
+### Option 2: Serve Separately
+
+Deploy the `build/web/` directory to any web server (nginx, Apache, etc.) and configure CORS on the backend.
+
+Example nginx configuration:
+
+```nginx
+server {
+    listen 80;
+    server_name pumaguard.local;
+
+    root /path/to/web-ui-flutter/build/web;
+    index index.html;
+
+    location / {
+        try_files $uri $uri/ /index.html;
+    }
+
+    location /api/ {
+        proxy_pass http://localhost:5000/api/;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection 'upgrade';
+        proxy_set_header Host $host;
+        proxy_cache_bypass $http_upgrade;
+    }
+}
+```
+
+## Troubleshooting
+
+### Cannot Connect to Backend
+
+**Error**: `Failed to connect to PumaGuard server`
+
+**Solutions**:
+
+1. Ensure the backend server is running
+2. Check the backend URL in `api_service.dart`
+3. Verify CORS is enabled on the backend (it should be by default)
+4. Check firewall settings
+
+### Flutter Build Issues
+
+**Error**: `Packages are not up to date`
+
+**Solution**:
+
+```bash
+flutter pub get
+```
+
+**Error**: `Cannot find module 'canvaskit'`
+
+**Solution**:
+
+```bash
+flutter clean
+flutter pub get
+flutter build web
+```
+
+### Settings Not Saving
+
+**Symptoms**: Settings appear to save but don't persist
+
+**Solutions**:
+
+1. Check backend logs for errors
+2. Verify write permissions on settings file
+3. Ensure settings file path is correctly configured in backend
+
+## Development Tips
+
+### Adding New Settings
+
+1. Add field to `Settings` model in `lib/models/settings.dart`
+2. Update `fromJson` and `toJson` methods
+3. Add UI control in `lib/screens/settings_screen.dart`
+4. Update backend to handle new setting
+
+### Customizing Theme
+
+Edit the `ThemeData` in `lib/main.dart`:
+
+```dart
+colorScheme: ColorScheme.fromSeed(
+  seedColor: const Color(0xFF8B4513), // Change this color
+  brightness: Brightness.light,
+),
+```
+
+### Adding New Screens
+
+1. Create screen file in `lib/screens/`
+2. Add navigation in `home_screen.dart` or app bar
+3. Update routing if using named routes
+
+## Testing
+
+Run tests:
+
+```bash
+flutter test
+```
+
+Run integration tests:
+
+```bash
+flutter test integration_test/
+```
+
+## Dependencies
+
+Main dependencies:
+
+- `flutter` - Flutter SDK
+- `http` ^1.1.0 - HTTP requests
+- `provider` ^6.1.0 - State management
+- `intl` ^0.19.0 - Internationalization
+
+Dev dependencies:
+
+- `flutter_test` - Testing framework
+- `flutter_lints` ^6.0.0 - Linting rules
+- `build_runner` ^2.4.0 - Code generation
+- `json_serializable` ^6.7.0 - JSON serialization
+
+## Contributing
+
+1. Follow Flutter style guidelines
+2. Run `flutter analyze` before committing
+3. Format code with `flutter format lib/`
+4. Add tests for new features
+
+## License
+
+Same as PumaGuard project.
+
+## Support
+
+For issues, see the main PumaGuard documentation or file an issue on the project repository.
+
+## Related Documentation
+
+- [PumaGuard Main README](../README.md)
+- [Backend API Documentation](../docs/api.md)
+- [Flutter Documentation](https://flutter.dev/docs)
+- [Material Design 3](https://m3.material.io/)