netbox-maintenance-device 1.2.1__tar.gz

netbox_maintenance_device-1.2.1/CHANGELOG.md

@@ -0,0 +1,64 @@
+# 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.2.1] - 2025-09-29
+
+### Added
+- **Complete REST API**: Full CRUD API implementation for external integrations
+  - 17 API endpoints for maintenance plans and executions
+  - Advanced filtering, pagination, and ordering
+  - Custom actions: schedule, complete, cancel maintenance
+  - Statistics and reporting endpoints
+  - Comprehensive permission system
+  - Token and session authentication support
+- **NetBox 4.4.x Compatibility**: Full compatibility with NetBox 4.4.1
+- **Enhanced Database Healing**: Plugin automatically detects and resolves orphaned table issues
+- **Production Deployment Ready**: Cleaned project structure for production use
+- **GitHub Actions Integration**: Automated testing and PyPI publishing workflows
+
+### Fixed
+- **[CRÍTICO] NetBox 4.4.x Compatibility**: Resolved all compatibility issues with NetBox 4.4.1
+  - Fixed `ModuleNotFoundError: No module named 'utilities.utils'`
+  - Fixed `ImportError: cannot import name 'NestedDeviceSerializer'`
+  - Updated permission system to use `rest_framework.permissions.BasePermission`
+  - Created custom `DeviceNestedSerializer` for NetBox 4.4.x compatibility
+- **[CRÍTICO] IntegrityError Resolution**: Automatically resolves foreign key constraint violations
+- **[CRÍTICO] Internationalization**: Fixed menu labels appearing in Portuguese when NetBox is set to English
+- **Docker Deployment**: Plugin now starts correctly in NetBox 4.4.1 containers
+
+### Changed
+- **Permission System**: Completely rewritten for NetBox 4.4.x compatibility
+- **API Serializers**: Updated to use NetBox 4.4.x compatible imports
+- **Project Structure**: Cleaned for production deployment (removed unnecessary documentation files)
+- **Package Naming**: Standardized to `netbox-maintenance-device` for PyPI
+- **License Format**: Updated to standard `Apache-2.0` format
+
+## [1.2.0] - 2025-09-16
+
+### Added
+- Enhanced visual indicators for maintenance status
+- Portuguese-BR localization support
+- Improved navigation and menu structure
+- Device maintenance integration tabs
+
+### Fixed
+- Various UI improvements
+- Better error handling in views
+
+## [1.1.0] - 2025-09-15
+
+### Added
+- Initial release with basic maintenance planning
+- Device maintenance plan management
+- Maintenance execution tracking
+- Basic reporting and dashboard
+
+### Features
+- Create maintenance plans for devices
+- Track maintenance executions
+- Monitor upcoming and overdue maintenance
+- Device integration with maintenance history

netbox_maintenance_device-1.2.1/LICENSE

@@ -0,0 +1,198 @@
+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 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" shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" 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 covered by this License,
+      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. (Preferably at the beginning of this file.)
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based upon (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 use, reproduce, modify, distribute, and 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, 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 notice 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 Support. You are not required to accept
+      warranty or support for the Work from any Contributor. However,
+      if You accept support, warranty, or indemnity obligations to or
+      for any recipient of the Work, You hereby 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 support.
+
+   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 page as the copyright notice for easier identification within
+      third-party archives.
+
+   Copyright 2025 Diego Godoy
+
+   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.

netbox_maintenance_device-1.2.1/MANIFEST.in

@@ -0,0 +1,13 @@
+include README.md
+include CHANGELOG.md
+include LICENSE
+recursive-include netbox_maintenance_device/templates *
+recursive-include netbox_maintenance_device/static *
+recursive-include netbox_maintenance_device/locale *
+recursive-include netbox_maintenance_device/migrations *
+global-exclude *.pyc
+global-exclude __pycache__
+global-exclude *.py[co]
+global-exclude *.DS_Store
+global-exclude .pytest_cache
+global-exclude tests

netbox_maintenance_device-1.2.1/PKG-INFO

@@ -0,0 +1,309 @@
+Metadata-Version: 2.4
+Name: netbox-maintenance-device
+Version: 1.2.1
+Summary: NetBox plugin for device maintenance management with comprehensive REST API and Portuguese-BR support
+Author-email: Diego Godoy <diegoalex-gdy@outlook.com>
+Maintainer-email: Diego Godoy <diegoalex-gdy@outlook.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/diegogodoy06/netbox-maintenance-device
+Project-URL: Bug Reports, https://github.com/diegogodoy06/netbox-maintenance-device/issues
+Project-URL: Source, https://github.com/diegogodoy06/netbox-maintenance-device
+Project-URL: Documentation, https://github.com/diegogodoy06/netbox-maintenance-device/blob/main/README.md
+Project-URL: Changelog, https://github.com/diegogodoy06/netbox-maintenance-device/releases
+Keywords: netbox,plugin,maintenance,device,preventive,corrective,api,rest,automation,infrastructure,django
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: Operating System :: OS Independent
+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: Framework :: Django
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-django>=4.5.0; extra == "dev"
+Requires-Dist: pre-commit>=2.20.0; extra == "dev"
+Dynamic: license-file
+
+# NetBox Maintenance Device Plugin
+
+[![Python](https://img.shields.io/badge/Python-3.8%2B-blue)](https://www.python.org/)
+[![NetBox](https://img.shields.io/badge/NetBox-4.0%2B-orange)](https://netbox.dev/)
+[![Language](https://img.shields.io/badge/Language-EN%20%7C%20PT--BR-brightgreen)](README.md)
+
+A comprehensive NetBox plugin for managing device preventive and corrective maintenance with enhanced visual indicators, scheduling capabilities, and multi-language support.
+
+![Upcoming & Overdue Maintenance](https://github.com/diegogodoy06/netbox-maintenance-device/blob/main/docs/img/Upcoming.png?raw=true)
+
+## Features
+
+- **Maintenance Plans**: Create and manage maintenance plans for devices with configurable frequency
+- **Maintenance Executions**: Record and track maintenance executions with status monitoring
+- **Device Integration**: View maintenance history directly on device pages with dedicated tabs
+- **Quick Actions**: Schedule and complete maintenance directly from the interface
+- **🆕 REST API**: Complete REST API for external integrations and automation
+- **Advanced Filtering**: Powerful filtering and search capabilities
+- **Custom Actions**: Schedule, complete, and cancel maintenance via API
+- **Statistics**: Get maintenance statistics and overdue/upcoming reports
+
+
+## Compatibility
+
+| NetBox Version | Plugin Support | Notes |
+|----------------|----------------|-------|
+| 4.4.x | ✅ **Tested & Supported** | Current target version |
+| 4.3.x | ⚠️ **Likely Compatible** | Not officially tested |
+| 4.2.x | ⚠️ **Likely Compatible** | Not officially tested |
+| 4.1.x | ⚠️ **Likely Compatible** | Not officially tested |
+| 4.0.x | ⚠️ **Likely Compatible** | Not officially tested |
+| 3.x | ❌ **Not Supported** | Breaking changes |
+
+> **Note**: This version (v1.2.1) is specifically tested and certified for NetBox 4.4.x. While it may work with other 4.x versions, we recommend testing in a development environment first.
+
+
+
+## Installation
+
+### Method 1: PyPI Installation 
+This plugin is not published on PyPI yet.  
+To install directly from GitHub, use:
+
+### Method 2: GitHub Installation
+
+```bash
+pip install git+https://github.com/diegogodoy06/netbox-maintenance-device.git
+```
+Note: You may see a warning about setup.py being deprecated.
+The installation still works fine, and a pyproject.toml will be added soon to remove this warning.
+
+### Method 3: Docker Installation
+
+For Docker-based NetBox installations using [netbox-docker](https://github.com/netbox-community/netbox-docker):
+
+> **📋 For detailed Docker installation instructions in English and Portuguese, see [DOCKER_INSTALL.md](DOCKER_INSTALL.md)**
+
+#### Quick Docker Setup
+
+## Installation
+
+### Method 1: PyPI (Recommended)
+
+```bash
+# Install via pip
+pip install netbox-maintenance-device
+```
+
+**For Docker deployments**, add to your `plugin_requirements.txt`:
+```bash
+echo "netbox-maintenance-device>=1.2.1" >> plugin_requirements.txt
+```
+
+### Method 2: From Source
+
+1. Add to `plugin_requirements.txt`:
+```bash
+echo "https://github.com/diegogodoy06/netbox-maintenance-device/archive/main.tar.gz" >> plugin_requirements.txt
+```
+
+2. Configure in `configuration/plugins.py`:
+```python
+PLUGINS = ['netbox_maintenance_device']
+```
+
+3. Rebuild and restart:
+```bash
+docker compose down
+docker compose build --no-cache
+docker compose up -d
+docker compose exec netbox python manage.py migrate
+```
+
+## Configuration
+
+### Basic Configuration
+
+Add the plugin to your NetBox `configuration.py`:
+
+```python
+# configuration.py
+
+PLUGINS = [
+    'netbox_maintenance_device',
+    # ... other plugins
+]
+
+# Optional: Plugin-specific settings
+PLUGINS_CONFIG = {
+    'netbox_maintenance_device': {
+        # Future configuration options will be added here
+        # Currently, the plugin uses default settings
+    }
+}
+```
+
+### Language Configuration (Optional)
+
+To enable Portuguese-BR by default:
+
+```python
+# configuration.py
+
+# Enable internationalization
+USE_I18N = True
+USE_L10N = True
+
+# Set default language
+LANGUAGE_CODE = 'pt-br'
+TIME_ZONE = 'America/Sao_Paulo'
+
+# Available languages
+LANGUAGES = [
+    ('en', 'English'),
+    ('pt-br', 'Português (Brasil)'),
+]
+```
+
+### Database Migration
+
+After configuration, run migrations:
+
+```bash
+python manage.py migrate
+```
+
+### Restart Services
+
+Restart your NetBox services:
+
+```bash
+# For systemd
+sudo systemctl restart netbox netbox-rq
+
+# For Docker
+docker compose restart netbox netbox-worker
+```
+
+## Screenshots
+
+### Device Maintenance Section
+*View maintenance plans and status directly on device pages*
+
+![Device Maintenance](https://github.com/diegogodoy06/netbox-maintenance-device/blob/main/docs/img/device.png?raw=true)
+
+### Upcoming Maintenance Dashboard
+*Monitor all upcoming and overdue maintenance across your infrastructure*
+
+![Upcoming Maintenance](https://github.com/diegogodoy06/netbox-maintenance-device/blob/main/docs/img/Upcoming.png?raw=true)
+
+### Maintenance Plan Management
+*Create and manage maintenance plans with flexible scheduling*
+
+![Maintenance Plans](https://github.com/diegogodoy06/netbox-maintenance-device/blob/main/docs/img/Plans.png?raw=true)
+
+
+##  Usage
+
+### Creating Maintenance Plans
+
+1. Navigate to **Plugins > Manutenção de Dispositivos > Planos de Manutenção**
+2. Click **Add** to create a new maintenance plan
+3. Select a device, provide a name, and set the frequency in days
+4. Choose between preventive or corrective maintenance type
+5. Save and activate the plan
+
+### Scheduling Maintenance
+
+#### From Device Page:
+1. Go to any device detail page
+2. View the **Maintenance** section
+3. Click the **📅 Schedule** button next to any plan
+4. Set date, technician, and notes
+5. Confirm to create a scheduled execution
+
+#### From Upcoming Maintenance:
+1. Navigate to **Plugins > Upcoming Maintenance**
+2. Find the maintenance plan in the table
+3. Click **📅 Schedule** in the Actions column
+4. Complete the scheduling form
+
+### Completing Maintenance
+
+#### Quick Complete:
+1. From the **Upcoming Maintenance** page or device section
+2. Click the **✅ Complete** button for overdue/due maintenance
+3. Add technician notes and confirm
+4. The system creates and marks the execution as completed
+
+#### Manual Recording:
+1. Navigate to **Plugins > Maintenance Executions**
+2. Click **Add** to record a new execution
+3. Select the plan, set dates, and update status
+4. Add detailed notes and technician information
+
+### Monitoring Maintenance
+
+#### Device-Level Monitoring:
+- **Maintenance Section**: Shows active plans with status badges
+- **Visual Indicators**: Red (overdue), yellow (due soon), green (on track)
+- **Quick Actions**: Schedule and complete buttons for urgent items
+
+#### Dashboard Monitoring:
+- **Upcoming Maintenance**: Centralized view of all maintenance
+- **Status Filters**: Filter by overdue, due soon, or scheduled
+- **Bulk Actions**: Manage multiple maintenance items efficiently
+
+## Models
+
+### MaintenancePlan
+- **Device**: Links to a specific NetBox device
+- **Name**: Descriptive name for the maintenance type
+- **Type**: Preventive or corrective maintenance
+- **Frequency**: Maintenance interval in days
+- **Status**: Active/inactive flag
+
+### MaintenanceExecution
+- **Plan**: Links to the maintenance plan
+- **Scheduled Date**: When maintenance is scheduled
+- **Completed Date**: When maintenance was completed
+- **Status**: scheduled, in_progress, completed, cancelled
+- **Technician**: Person responsible for maintenance
+- **Notes**: Detailed maintenance notes
+
+
+### Available Endpoints
+
+| Endpoint | Operations | Description |
+|----------|------------|-------------|
+| `/maintenance-plans/` | CRUD + Custom Actions | Manage maintenance plans |
+| `/maintenance-executions/` | CRUD + Custom Actions | Manage maintenance executions |
+| `/maintenance-plans/overdue/` | GET | Get overdue plans |
+| `/maintenance-plans/upcoming/` | GET | Get upcoming plans |
+| `/maintenance-plans/statistics/` | GET | Get plan statistics |
+| `/maintenance-executions/pending/` | GET | Get pending executions |
+
+
+---
+
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📄 License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- NetBox community for the excellent platform
+- Contributors and users providing feedback