netbox-notices 0.1.0__tar.gz

netbox_notices-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,116 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at https://github.com/jsenecal/netbox-notices/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+### Write Documentation
+
+NetBox Vendor Notification Plugin could always use more documentation, whether as part of the
+official NetBox Vendor Notification Plugin docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at https://github.com/jsenecal/netbox-notices/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that contributions are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `netbox-notices` for local development.
+
+1. Fork the `netbox-notices` repo on GitHub.
+2. Clone your fork locally
+
+    ```
+    $ git clone git@github.com:your_name_here/netbox-notices.git
+    ```
+
+3. Install dependencies and start your virtualenv:
+
+    ```
+    $ python3 -m venv venv
+    $ source venv/bin/activate
+    $ pip install -e ".[dev]"
+    ```
+
+4. Create a branch for local development:
+
+    ```
+    $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+    Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass the
+   tests and linting:
+
+    ```
+    $ ./venv/bin/pytest tests/ -v
+    $ ./venv/bin/ruff format notices/ tests/
+    $ ./venv/bin/ruff check --fix notices/ tests/
+    ```
+
+6. Commit your changes and push your branch to GitHub:
+
+    ```
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+    ```
+
+7. Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.md.
+3. The pull request should work for Python 3.10, 3.11, and 3.12. Check
+   https://github.com/jsenecal/netbox-notices/actions
+   and make sure that the tests pass for all supported Python versions.
+
+
+## Deploying
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in CHANGELOG.md).
+Then run:
+
+```
+$ pip install bumpver build twine
+$ bumpver update --patch  # or --minor, --major
+$ python -m build
+$ twine upload dist/*
+```

netbox_notices-0.1.0/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.

netbox_notices-0.1.0/MANIFEST.in

@@ -0,0 +1,14 @@
+include CONTRIBUTING.md
+include LICENSE
+include README.md
+
+recursive-include vendor_notification/templates *
+recursive-include vendor_notification/api *
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-exclude parsers/*
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

netbox_notices-0.1.0/PKG-INFO

@@ -0,0 +1,365 @@
+Metadata-Version: 2.4
+Name: netbox-notices
+Version: 0.1.0
+Summary: Track maintenance and outage events across various NetBox models from vendors and internal sources.
+Author-email: Jonathan Senecal <contact@jonathansenecal.com>, Jason Yates <me@jasonyates.co.uk>
+Project-URL: Homepage, https://github.com/jsenecal/netbox-vendor-notification
+Project-URL: Documentation, https://github.com/jsenecal/netbox-vendor-notification
+Project-URL: Source, https://github.com/jsenecal/netbox-vendor-notification
+Project-URL: Tracker, https://github.com/jsenecal/netbox-vendor-notification/issues
+Keywords: notices
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: icalendar>=5.0.0
+Provides-Extra: dev
+Requires-Dist: black==25.1.0; extra == "dev"
+Requires-Dist: bumpver; extra == "dev"
+Requires-Dist: isort==6.0.1; extra == "dev"
+Requires-Dist: pip-tools; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-django>=4.5.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
+Requires-Dist: flake8>=7.0.0; extra == "dev"
+Requires-Dist: pyproject-flake8>=7.0.0; extra == "dev"
+Requires-Dist: twine==6.1.0; extra == "dev"
+Requires-Dist: Sphinx==8.2.3; extra == "dev"
+Requires-Dist: watchdog==6.0.0; extra == "dev"
+Dynamic: license-file
+
+# NetBox Notices
+
+**Repository:** [github.com/jsenecal/netbox-notices](https://github.com/jsenecal/netbox-notices)
+
+**Original Project:** Forked and inspired from [jasonyates/netbox-circuitmaintenance](https://github.com/jasonyates/netbox-circuitmaintenance), differs in the ability to track more than just maintenances, and circuits.
+
+A NetBox plugin built to track maintenance and outage events across various NetBox models. This plugin is agnostic in that it is only built to store data surrounding maintenance/outage events and provide an overview of historical, active and upcoming events. The plugin tracks events at the provider level and associates impact across multiple NetBox object types (circuits, devices, virtual machines, power feeds, sites, etc.).
+
+The plugin does not directly provide an automated approach to ingesting provider notifications, instead it extends NetBox's extensive REST API and provides GET/POST/PUT/PATCH methods to manage events. The plugin is intended to be coupled with an automated parser to handle the parsing of provider notifications and the delivery of the events to the plugin's REST API. Several example parsers have been [documented in the upstream project](https://jasonyates.github.io/netbox-circuitmaintenance/parsers/).
+
+**Important Note:** This is a significant refactoring from the original `netbox-circuitmaintenance` plugin. **There is no upgrade path** from the original plugin. If you are using the original plugin, you will need to migrate your data manually.
+
+## Features
+
+- Track provider maintenance events
+- Track impact from provider maintenance across multiple NetBox object types
+- Configurable allowed object types (circuits, devices, virtual machines, power feeds, sites, etc.)
+- Provides a consolidated view of active, upcoming and historical maintenance events at the provider and object level
+- Track unplanned outage events with optional end times and ETR tracking
+- Unified event notification tracking
+- Maintenance overlap detection (coming soon)
+
+## Compatibility
+
+This plugin requires NetBox 4.4.1 or higher.
+
+| NetBox Version | Plugin Version |
+| -------------- | -------------- |
+| 4.4.1+         | 0.1.0          |
+
+## Installing
+
+A working installation of Netbox 4.4.1+ is required - [see official documentation](https://netbox.readthedocs.io/en/stable/plugins/).
+
+### Package Installation
+
+Activate your virtual env and install via pip:
+
+```bash
+$ source /opt/netbox/venv/bin/activate
+(venv) $ pip install netbox-notices
+```
+
+To ensure the plugin is automatically re-installed during future upgrades, add the package to your `local_requirements.txt`:
+
+```bash
+# echo netbox-notices >> local_requirements.txt
+```
+
+### Enable the Plugin
+
+In the Netbox `configuration.py` configuration file add or update the PLUGINS parameter, adding `vendor_notification`:
+
+```python
+PLUGINS = [
+    'notices'
+]
+
+PLUGINS_CONFIG = {
+    "notices": {},
+}
+```
+
+### Configuration
+
+The plugin supports configuration of which NetBox object types can be linked to maintenance and outage events. By default, the plugin allows linking to circuits, power feeds, and sites.
+
+#### Default Configuration
+
+If you don't specify any configuration, the plugin uses these defaults:
+
+```python
+PLUGINS_CONFIG = {
+    "notices": {
+        "allowed_content_types": [
+            "circuits.Circuit",
+            "dcim.PowerFeed",
+            "dcim.Site",
+        ]
+    }
+}
+```
+
+#### Custom Configuration
+
+You can customize which object types are allowed by specifying the `allowed_content_types` setting. Content types are specified in the format `app_label.model_name`.
+
+##### Example: Add Devices and Virtual Machines
+
+```python
+PLUGINS_CONFIG = {
+    "notices": {
+        "allowed_content_types": [
+            "circuits.Circuit",
+            "dcim.Device",
+            "dcim.PowerFeed",
+            "dcim.Site",
+            "virtualization.VirtualMachine",
+        ]
+    }
+}
+```
+
+##### Example: Minimal Configuration (Circuits Only)
+
+```python
+PLUGINS_CONFIG = {
+    "notices": {
+        "allowed_content_types": [
+            "circuits.Circuit",
+        ]
+    }
+}
+```
+
+##### Example: Extended Configuration
+
+```python
+PLUGINS_CONFIG = {
+    "notices": {
+        "allowed_content_types": [
+            "circuits.Circuit",
+            "dcim.Device",
+            "dcim.Interface",
+            "dcim.PowerFeed",
+            "dcim.Rack",
+            "dcim.Site",
+            "ipam.IPAddress",
+            "ipam.Prefix",
+            "virtualization.VirtualMachine",
+            "virtualization.VMInterface",
+        ]
+    }
+}
+```
+
+##### How Configuration Affects Behavior
+
+- Only object types listed in `allowed_content_types` will appear in the Impact creation forms
+- The API will reject attempts to create impacts for non-allowed object types
+- Changing the configuration requires a NetBox restart
+- This setting controls which objects can be linked via the `Impact` model to maintenance and outage events
+
+##### Common NetBox Object Types
+
+| Content Type                    | Description               |
+| ------------------------------- | ------------------------- |
+| `circuits.Circuit`              | Network circuits          |
+| `circuits.Provider`             | Service providers         |
+| `dcim.Device`                   | Physical network devices  |
+| `dcim.Interface`                | Device network interfaces |
+| `dcim.PowerFeed`                | Power supply connections  |
+| `dcim.PowerPanel`               | Power distribution panels |
+| `dcim.Rack`                     | Equipment racks           |
+| `dcim.Site`                     | Physical locations        |
+| `ipam.IPAddress`                | IP addresses              |
+| `ipam.Prefix`                   | IP prefixes/subnets       |
+| `virtualization.VirtualMachine` | Virtual machines          |
+| `virtualization.VMInterface`    | VM network interfaces     |
+
+### Apply Database Migrations
+
+Apply database migrations with Netbox `manage.py`:
+
+```bash
+(venv) $ python manage.py migrate
+```
+
+### Restart Netbox
+
+Restart the Netbox service to apply changes:
+
+```bash
+sudo systemctl restart netbox
+```
+
+## Outage Tracking
+
+In addition to planned maintenance, this plugin supports tracking unplanned outage events:
+
+### Key Features
+
+- **Optional End Time**: Outages can be created without an end time, which becomes required when marking as resolved
+- **ETR Tracking**: Track Estimated Time to Repair with full revision history via NetBox's changelog
+- **Outage Status Workflow**:
+  - REPORTED: Initial state when outage is reported
+  - INVESTIGATING: Team is investigating root cause
+  - IDENTIFIED: Root cause identified, working on fix
+  - MONITORING: Fix applied, monitoring for stability
+  - RESOLVED: Outage fully resolved (requires end time)
+- **Shared Impact Model**: Uses the same impact tracking as maintenance events (Impact model)
+- **Unified View**: View both maintenance and outages together in a single interface
+- **Flexible Object Support**: Link outages to any configured NetBox object type
+
+### API Endpoints
+
+**Maintenance Events:**
+
+```text
+GET    /api/plugins/notices/maintenance/
+POST   /api/plugins/notices/maintenance/
+GET    /api/plugins/notices/maintenance/{id}/
+PATCH  /api/plugins/notices/maintenance/{id}/
+DELETE /api/plugins/notices/maintenance/{id}/
+```
+
+**Outage Events:**
+
+```text
+GET    /api/plugins/notices/outage/
+POST   /api/plugins/notices/outage/
+GET    /api/plugins/notices/outage/{id}/
+PATCH  /api/plugins/notices/outage/{id}/
+DELETE /api/plugins/notices/outage/{id}/
+```
+
+**Impact Tracking:**
+
+```text
+GET    /api/plugins/notices/impact/
+POST   /api/plugins/notices/impact/
+GET    /api/plugins/notices/impact/{id}/
+PATCH  /api/plugins/notices/impact/{id}/
+DELETE /api/plugins/notices/impact/{id}/
+```
+
+### Example: Creating an Outage
+
+```json
+POST /api/plugins/notices/outage/
+{
+    "name": "OUT-2024-001",
+    "summary": "Fiber cut on Main Street",
+    "provider": 1,
+    "start": "2024-10-29T14:30:00Z",
+    "estimated_time_to_repair": "2024-10-29T18:00:00Z",
+    "status": "INVESTIGATING"
+}
+```
+
+### Example: Creating Impact for a Circuit
+
+```json
+POST /api/plugins/notices/impact/
+{
+    "maintenance": 1,
+    "content_type": "circuits.circuit",
+    "object_id": 42,
+    "impact": "OUTAGE"
+}
+```
+
+### Example: Creating Impact for a Device
+
+```json
+POST /api/plugins/notices/impact/
+{
+    "outage": 1,
+    "content_type": "dcim.device",
+    "object_id": 123,
+    "impact": "DEGRADED"
+}
+```
+
+## Data Models
+
+The plugin uses four main models to track maintenance and outage events:
+
+### Maintenance
+
+Represents a planned maintenance event from a provider. Key fields:
+
+- `name`: Event identifier
+- `summary`: Description of the maintenance
+- `provider`: Foreign key to NetBox Provider
+- `start`, `end`: Maintenance window times
+- `status`: TENTATIVE, CONFIRMED, CANCELLED, IN-PROCESS, COMPLETED, RE-SCHEDULED, UNKNOWN
+- `internal_ticket`: Your organization's tracking ticket reference
+- `acknowledged`: Whether the event has been acknowledged
+
+### Outage
+
+Represents an unplanned outage event from a provider. Key fields:
+
+- `name`: Event identifier
+- `summary`: Description of the outage
+- `provider`: Foreign key to NetBox Provider
+- `start`, `end`: Outage window times (end is optional until resolved)
+- `status`: REPORTED, INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED
+- `estimated_time_to_repair`: ETR timestamp (tracked with changelog history)
+- `internal_ticket`: Your organization's tracking ticket reference
+- `acknowledged`: Whether the event has been acknowledged
+
+### Impact
+
+Links maintenance or outage events to affected NetBox objects using Django's Generic Foreign Key pattern:
+
+- `maintenance` or `outage`: Foreign key to the event (mutually exclusive)
+- `content_type`: The type of affected object (e.g., "circuits.circuit", "dcim.device")
+- `object_id`: The ID of the affected object
+- `impact`: Impact level - NO-IMPACT, REDUCED-REDUNDANCY, DEGRADED, OUTAGE
+
+The Impact model allows linking events to **any NetBox object type** configured in `allowed_content_types`.
+
+### EventNotification
+
+Stores raw email notifications received from providers:
+
+- `maintenance` or `outage`: Foreign key to the associated event
+- `email`: Binary email data
+- `email_body`: Extracted body text
+- `subject`: Email subject line
+- `email_from`: Sender address
+- `email_received`: Receipt timestamp
+
+## Screenshots
+
+![Maintenance Event View](docs/img/maintenance.png)
+![Circuit Maintenance View](docs/img/circuit_maintenance.png)
+![Provider Maintenance View](docs/img/provider_maintenance.png)
+
+## Credits
+
+Based on the NetBox plugin tutorial:
+
+- [demo repository](https://github.com/netbox-community/netbox-plugin-demo)
+- [tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [`netbox-community/cookiecutter-netbox-plugin`](https://github.com/netbox-community/cookiecutter-netbox-plugin) project template.