Sign Up
Log In
Log In
or
Sign Up
Places
All Projects
Status Monitor
Collapse sidebar
openSUSE:infrastructure:netbox
netbox-healthcheck-plugin
_service:obs_scm:netbox-healthcheck-plugin-0.1....
Overview
Repositories
Revisions
Requests
Users
Attributes
Meta
File _service:obs_scm:netbox-healthcheck-plugin-0.1.4.obscpio of Package netbox-healthcheck-plugin
07070100000000000041ED0000000000000000000000026614304800000000000000000000000000000000000000000000002E00000000netbox-healthcheck-plugin-0.1.4/.devcontainer07070100000001000081A40000000000000000000000016614304800000154000000000000000000000000000000000000003900000000netbox-healthcheck-plugin-0.1.4/.devcontainer/DockerfileFROM mcr.microsoft.com/devcontainers/python:3 RUN python -m pip install --upgrade pip \ && python -m pip install 'flit>=3.8.0' ENV FLIT_ROOT_INSTALL=1 COPY pyproject.toml . RUN touch README.md \ && mkdir -p src/python_package \ && python -m flit install --only-deps --deps develop \ && rm -r pyproject.toml README.md src 07070100000002000081A40000000000000000000000016614304800000617000000000000000000000000000000000000004000000000netbox-healthcheck-plugin-0.1.4/.devcontainer/devcontainer.json// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: // https://github.com/microsoft/vscode-dev-containers/tree/v0.222.0/containers/python-3-miniconda { "name": "Python Environment", "build": { "dockerfile": "Dockerfile", "context": ".." }, "customizations": { "vscode": { "extensions": [ "editorconfig.editorconfig", "github.vscode-pull-request-github", "ms-azuretools.vscode-docker", "ms-python.python", "ms-python.vscode-pylance", "ms-python.pylint", "ms-python.isort", "ms-python.flake8", "ms-python.black-formatter", "ms-vsliveshare.vsliveshare", "ryanluker.vscode-coverage-gutters", "bungcip.better-toml", "GitHub.copilot" ], "settings": { "python.defaultInterpreterPath": "/usr/local/bin/python", "black-formatter.path": [ "/usr/local/py-utils/bin/black" ], "pylint.path": [ "/usr/local/py-utils/bin/pylint" ], "flake8.path": [ "/usr/local/py-utils/bin/flake8" ], "isort.path": [ "/usr/local/py-utils/bin/isort" ] } } }, "onCreateCommand": "pre-commit install-hooks" } 07070100000003000081A40000000000000000000000016614304800000124000000000000000000000000000000000000002E00000000netbox-healthcheck-plugin-0.1.4/.editorconfig# http://editorconfig.org root = true [*] indent_style = space indent_size = 4 trim_trailing_whitespace = true insert_final_newline = true charset = utf-8 end_of_line = lf [*.bat] indent_style = tab end_of_line = crlf [LICENSE] insert_final_newline = false [Makefile] indent_style = tab 07070100000004000081A4000000000000000000000001661430480000001F000000000000000000000000000000000000002800000000netbox-healthcheck-plugin-0.1.4/.flake8[flake8] max-line-length = 120 07070100000005000041ED0000000000000000000000046614304800000000000000000000000000000000000000000000002800000000netbox-healthcheck-plugin-0.1.4/.github07070100000006000041ED0000000000000000000000026614304800000000000000000000000000000000000000000000003700000000netbox-healthcheck-plugin-0.1.4/.github/ISSUE_TEMPLATE07070100000007000081A400000000000000000000000166143048000007AB000000000000000000000000000000000000004700000000netbox-healthcheck-plugin-0.1.4/.github/ISSUE_TEMPLATE/bug_report.yaml--- name: 🐛 Bug Report description: Report a reproducible bug in the current release of NetBox HealthCheck Plugin labels: ["type: bug"] body: - type: markdown attributes: value: > **NOTE:** This form is only for reporting _reproducible bugs_ in a current NetBox HealthCheck Plugin release. - type: input attributes: label: NetBox HealthCheck Plugin version description: What version of NetBox HealthCheck Plugin are you currently running? placeholder: v0.1.0 validations: required: true - type: input attributes: label: NetBox version description: What version of NetBox are you currently running? placeholder: v3.6.0 validations: required: true - type: dropdown attributes: label: Python version description: What version of Python are you currently running? options: - "3.8" - "3.9" - "3.10" - "3.11" validations: required: true - type: textarea attributes: label: Steps to Reproduce description: > Please provide a minimal working example to demonstrate the bug. Begin with the initialization of any necessary database objects and clearly enumerate each operation carried out. Ensure that your example is as concise as possible while adequately illustrating the issue. _Please refrain from including any confidential or sensitive information in your example._ validations: required: true - type: textarea attributes: label: Expected Behavior description: What did you expect to happen? placeholder: The script should execute without raising any errors or exceptions validations: required: true - type: textarea attributes: label: Observed Behavior description: What happened instead? placeholder: A TypeError exception was raised validations: required: true 07070100000008000081A4000000000000000000000001661430480000031A000000000000000000000000000000000000004200000000netbox-healthcheck-plugin-0.1.4/.github/ISSUE_TEMPLATE/config.yml# Reference: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser blank_issues_enabled: false contact_links: - name: 📖 Contributing Policy url: https://github.com/netbox-community/netbox-healthcheck-plugin/blob/main/CONTRIBUTING.md about: "Please read through our contributing policy before opening an issue or pull request." - name: ❓ Discussion url: https://github.com/netbox-community/netbox-healthcheck-plugin/discussions about: "If you're just looking for help, try starting a discussion instead." - name: 💬 Community Slack url: https://netdev.chat about: "Join #netbox on the NetDev Community Slack for assistance with installation issues and other problems." 07070100000009000081A400000000000000000000000166143048000008F3000000000000000000000000000000000000004C00000000netbox-healthcheck-plugin-0.1.4/.github/ISSUE_TEMPLATE/feature_request.yaml--- name: ✨ Feature Request description: Propose a new NetBox HealthCheck Plugin feature or enhancement labels: ["type: feature"] body: - type: markdown attributes: value: > **NOTE:** This form is only for submitting well-formed proposals to extend or modify NetBox HealthCheck Plugin in some way. If you're trying to solve a problem but can't figure out how, or if you still need time to work on the details of a proposed new feature, please start a [discussion](https://github.com/netbox-community/pynetbox/discussions) instead. - type: input attributes: label: NetBox HealthCheck Plugin version description: What version of NetBox HealthCheck Plugin are you currently running? placeholder: v0.1.0 validations: required: true - type: input attributes: label: NetBox version description: What version of NetBox are you currently running? placeholder: v3.6.0 validations: required: true - type: dropdown attributes: label: Feature type options: - Data model extension - New functionality - Change to existing functionality validations: required: true - type: textarea attributes: label: Proposed functionality description: > Describe in detail the new feature or behavior you are proposing. Include any specific changes to work flows, data models, and/or the user interface. The more detail you provide here, the greater chance your proposal has of being discussed. Feature requests which don't include an actionable implementation plan will be rejected. validations: required: true - type: textarea attributes: label: Use case description: > Explain how adding this functionality would benefit NetBox HealthCheck Plugin users. What need does it address? validations: required: true - type: textarea attributes: label: External dependencies description: > List any new dependencies on external libraries or services that this new feature would introduce. For example, does the proposal require the installation of a new Python package? (Not all new features introduce new dependencies.) 0707010000000A000081A4000000000000000000000001661430480000033B000000000000000000000000000000000000004900000000netbox-healthcheck-plugin-0.1.4/.github/ISSUE_TEMPLATE/housekeeping.yaml--- name: 🏡 Housekeeping description: A change pertaining to the codebase itself (developers only) labels: ["type: housekeeping"] body: - type: markdown attributes: value: > **NOTE:** This template is for use by maintainers only. Please do not submit an issue using this template unless you have been specifically asked to do so. - type: textarea attributes: label: Proposed Changes description: > Describe in detail the new feature or behavior you'd like to propose. Include any specific changes to work flows, data models, or the user interface. validations: required: true - type: textarea attributes: label: Justification description: Please provide justification for the proposed change(s). validations: required: true 0707010000000B000041ED0000000000000000000000026614304800000000000000000000000000000000000000000000003200000000netbox-healthcheck-plugin-0.1.4/.github/workflows0707010000000C000081A400000000000000000000000166143048000001C9000000000000000000000000000000000000003D00000000netbox-healthcheck-plugin-0.1.4/.github/workflows/mkdocs.ymlname: ci on: push: branches: - master - main permissions: contents: write jobs: deploy: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - uses: actions/setup-python@v4 with: python-version: 3.x - run: pip install mkdocs-material mkdocs-autorefs mkdocs-material-extensions mkdocstrings mkdocstrings-python-legacy mkdocs-include-markdown-plugin - run: mkdocs gh-deploy --force 0707010000000D000081A40000000000000000000000016614304800000596000000000000000000000000000000000000004300000000netbox-healthcheck-plugin-0.1.4/.github/workflows/publish-pypi.yml# see: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/ name: Publish Python 🐍 distribution 📦 to PyPI on: push jobs: build: name: Build distribution 📦 runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Set up Python uses: actions/setup-python@v5.1.0 with: python-version: "3.x" - name: Install pypa/build run: >- python3 -m pip install build --user - name: Build a binary wheel and a source tarball run: python3 -m build - name: Store the distribution packages uses: actions/upload-artifact@v4 with: name: python-package-distributions path: dist/ publish-to-pypi: name: >- Publish Python 🐍 distribution 📦 to PyPI if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes needs: - build runs-on: ubuntu-latest environment: name: pypi url: https://pypi.org/p/netbox-healthcheck-plugin permissions: id-token: write # IMPORTANT: mandatory for trusted publishing steps: - name: Download all the dists uses: actions/download-artifact@v4 with: name: python-package-distributions path: dist/ - name: Publish distribution 📦 to PyPI uses: pypa/gh-action-pypi-publish@release/v1 0707010000000E000081A4000000000000000000000001661430480000145B000000000000000000000000000000000000002B00000000netbox-healthcheck-plugin-0.1.4/.gitignore# https://github.com/github/gitignore/blob/main/Global/macOS.gitignore # General .DS_Store .AppleDouble .LSOverride # Icon must end with two \r Icon # Thumbnails ._* # Files that might appear in the root of a volume .DocumentRevisions-V100 .fseventsd .Spotlight-V100 .TemporaryItems .Trashes .VolumeIcon.icns .com.apple.timemachine.donotpresent # Directories potentially created on remote AFP share .AppleDB .AppleDesktop Network Trash Folder Temporary Items .apdisk # https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore .vscode/* !.vscode/settings.json !.vscode/tasks.json !.vscode/launch.json !.vscode/extensions.json !.vscode/*.code-snippets # Local History for Visual Studio Code .history/ # Built Visual Studio Code Extensions *.vsix # https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 # User-specific stuff .idea/**/workspace.xml .idea/**/tasks.xml .idea/**/usage.statistics.xml .idea/**/dictionaries .idea/**/shelf # AWS User-specific .idea/**/aws.xml # Generated files .idea/**/contentModel.xml # Sensitive or high-churn files .idea/**/dataSources/ .idea/**/dataSources.ids .idea/**/dataSources.local.xml .idea/**/sqlDataSources.xml .idea/**/dynamic.xml .idea/**/uiDesigner.xml .idea/**/dbnavigator.xml # Gradle .idea/**/gradle.xml .idea/**/libraries # Gradle and Maven with auto-import # When using Gradle or Maven with auto-import, you should exclude module files, # since they will be recreated, and may cause churn. Uncomment if using # auto-import. # .idea/artifacts # .idea/compiler.xml # .idea/jarRepositories.xml # .idea/modules.xml # .idea/*.iml # .idea/modules # *.iml # *.ipr # CMake cmake-build-*/ # Mongo Explorer plugin .idea/**/mongoSettings.xml # File-based project format *.iws # IntelliJ out/ # mpeltonen/sbt-idea plugin .idea_modules/ # JIRA plugin atlassian-ide-plugin.xml # Cursive Clojure plugin .idea/replstate.xml # SonarLint plugin .idea/sonarlint/ # Crashlytics plugin (for Android Studio and IntelliJ) com_crashlytics_export_strings.xml crashlytics.properties crashlytics-build.properties fabric.properties # Editor-based Rest Client .idea/httpRequests # Android studio 3.1+ serialized cache file .idea/caches/build_file_checksums.ser # https://github.com/github/gitignore/blob/main/Python.gitignore # 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/ # 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/ 0707010000000F000081A400000000000000000000000166143048000001E7000000000000000000000000000000000000003800000000netbox-healthcheck-plugin-0.1.4/.pre-commit-config.yamlci: autoupdate_commit_msg: "chore: update pre-commit hooks" autofix_commit_msg: "style: pre-commit fixes" repos: - repo: https://github.com/psf/black rev: 24.3.0 hooks: - id: black args: [--line-length=120] language_version: python3.11 - repo: https://github.com/PyCQA/flake8 rev: 7.0.0 hooks: - id: flake8 - repo: https://github.com/mgedmin/check-manifest rev: "0.49" hooks: - id: check-manifest stages: [manual] 07070100000010000081A4000000000000000000000001661430480000009E000000000000000000000000000000000000002800000000netbox-healthcheck-plugin-0.1.4/.pypirc[distutils] index-servers = pypi testpypi [pypi] repository = https://upload.pypi.org/legacy/ [testpypi] repository = https://test.pypi.org/legacy/ 07070100000011000081A400000000000000000000000166143048000000B7000000000000000000000000000000000000002D00000000netbox-healthcheck-plugin-0.1.4/CHANGELOG.md# Changelog ## 0.1.2 (2024-04-08) * Fix django-health-check dependency in pyproject.toml ## 0.1.2 (2024-04-05) * General cleanup ## 0.1.0 (2023-01-18) * First release on PyPI. 07070100000012000081A400000000000000000000000166143048000010AE000000000000000000000000000000000000003000000000netbox-healthcheck-plugin-0.1.4/CONTRIBUTING.md# Contributing Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: - Reporting a bug - Discussing the current state of the code - Submitting a fix - Proposing new features - Becoming a maintainer ## General Tips for Working on GitHub * Register for a free [GitHub account](https://github.com/signup) if you haven't already. * You can use [GitHub Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for formatting text and adding images. * To help mitigate notification spam, please avoid "bumping" issues with no activity. (To vote an issue up or down, use a :thumbsup: or :thumbsdown: reaction.) * Please avoid pinging members with `@` unless they've previously expressed interest or involvement with that particular issue. * Familiarize yourself with [this list of discussion anti-patterns](https://github.com/bradfitz/issue-tracker-behaviors) and make every effort to avoid them. ## Types of Contributions ### Report Bugs Report bugs at https://github.com/netbox-community/netbox-healthcheck-plugin/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 HealthCheck Plugin could always use more documentation, whether as part of the official NetBox HealthCheck 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/netbox-community/netbox-healthcheck-plugin/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 this is a volunteer-driven project, and that contributions are welcome :) ## Get Started! Ready to contribute? Here's how to set up `netbox-healthcheck-plugin` for local development. 1. Fork the `netbox-healthcheck-plugin` repo on GitHub. 2. Clone your fork locally ``` $ git clone git@github.com:your_name_here/netbox-healthcheck-plugin.git ``` 3. Install dependencies and start your virtualenv: ``` $ poetry install -E test -E doc -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, including testing other Python versions, with tox: ``` $ poetry run tox ``` 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.6, 3.7, 3.8 and 3.9. Check https://github.com/netbox-community/netbox-healthcheck-plugin/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: ``` $ poetry run bump2version patch # possible: major / minor / patch $ git push $ git push --tags ``` GitHub Actions will then deploy to PyPI if tests pass. 07070100000013000081A400000000000000000000000166143048000027BF000000000000000000000000000000000000002800000000netbox-healthcheck-plugin-0.1.4/LICENSE 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 07070100000014000081A400000000000000000000000166143048000000ED000000000000000000000000000000000000002C00000000netbox-healthcheck-plugin-0.1.4/MANIFEST.ininclude CONTRIBUTING.md include LICENSE include README.md recursive-include tests * recursive-exclude * __pycache__ recursive-exclude * *.py[co] recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif graft templates 07070100000015000081A40000000000000000000000016614304800000127000000000000000000000000000000000000002900000000netbox-healthcheck-plugin-0.1.4/Makefilesources = NetBox HealthCheck Plugin .PHONY: test format lint unittest pre-commit clean test: format lint unittest format: isort $(sources) tests black $(sources) tests lint: flake8 $(sources) tests pre-commit: pre-commit run --all-files clean: rm -rf *.egg-info rm -rf .tox dist site 07070100000016000081A400000000000000000000000166143048000008E6000000000000000000000000000000000000002A00000000netbox-healthcheck-plugin-0.1.4/README.md# NetBox HealthCheck Plugin NetBox plugin for HealthCheck. NetBox provides health check monitors that can be queried to make sure that the service is running in good condition. NetBox exposes metrics at the `/healthcheck` HTTP endpoint, e.g. `https://netbox.local/healthcheck`. It allows monitor conditions via HTTP(S), with responses available in HTML and JSON formats. * Free software: Apache-2.0 * Documentation: https://netbox-community.github.io/netbox-healthcheck-plugin/ ## Features The features the plugin provides should be listed here. ## Compatibility | NetBox Version | Plugin Version | |----------------|----------------| | 3.4 - 3.7 | 0.1.0 | | 3.4 - 3.7 | 0.1.2 | | 3.4 - 3.7 | 0.1.3 | ## Installing For adding to a NetBox Docker setup see [the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins). While this is still in development and not yet on pypi you can install with pip: ```bash pip install git+https://github.com/netbox-community/netbox-healthcheck-plugin ``` or by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker): ```bash git+https://github.com/netbox-community/netbox-healthcheck-plugin ``` Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`, or if you use netbox-docker, your `/configuration/plugins.py` file : ```python PLUGINS = [ 'netbox_healthcheck_plugin' ] PLUGINS_CONFIG = { "netbox_healthcheck_plugin": {}, } ``` ## Setting up Monitoring NetBox makes use of the [django-health-check](https://github.com/revsys/django-health-check) library, more information on setting up monitors can be found at [Setting up Monitoring](https://django-health-check.readthedocs.io/en/latest/readme.html#setting-up-monitoring): ## 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. 07070100000017000041ED0000000000000000000000026614304800000000000000000000000000000000000000000000002500000000netbox-healthcheck-plugin-0.1.4/docs07070100000018000081A4000000000000000000000001661430480000002B000000000000000000000000000000000000003200000000netbox-healthcheck-plugin-0.1.4/docs/changelog.md{% include-markdown "../CHANGELOG.md" %} 07070100000019000081A4000000000000000000000001661430480000002E000000000000000000000000000000000000003500000000netbox-healthcheck-plugin-0.1.4/docs/contributing.md{% include-markdown "../CONTRIBUTING.md" %} 0707010000001A000081A4000000000000000000000001661430480000002A000000000000000000000000000000000000002E00000000netbox-healthcheck-plugin-0.1.4/docs/index.md{% include-markdown "../README.md" %} 0707010000001B000081A4000000000000000000000001661430480000081D000000000000000000000000000000000000002B00000000netbox-healthcheck-plugin-0.1.4/mkdocs.ymlsite_name: NetBox HealthCheck Plugin site_url: https://netbox-community.github.io/netbox-healthcheck-plugin repo_url: https://github.com/netbox-community/netbox-healthcheck-plugin repo_name: netbox-community/netbox-healthcheck-plugin #strict: true nav: - Home: index.md - Contributing: contributing.md - Changelog: changelog.md theme: name: material language: en #logo: assets/logo.png palette: scheme: preference primary: indigo accent: indigo features: - navigation.indexes - navigation.instant - navigation.tabs.sticky markdown_extensions: - attr_list - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.critic - pymdownx.caret - pymdownx.mark - pymdownx.tilde - pymdownx.tabbed - attr_list - pymdownx.arithmatex: generic: true - pymdownx.highlight: linenums: false - pymdownx.superfences - pymdownx.inlinehilite - pymdownx.details - admonition - toc: baselevel: 2 permalink: true slugify: !!python/name:pymdownx.slugs.uslugify - meta plugins: - include-markdown - search: lang: en - mkdocstrings: watch: - netbox-healthcheck-plugin extra: social: - icon: fontawesome/brands/twitter # replace with your own tweet link below link: https://github.com/netbox-community/cookiecutter-netbox-plugin name: Tweet - icon: fontawesome/brands/facebook # replace with your own facebook link below link: https://github.com/netbox-community/cookiecutter-netbox-plugin name: Facebook - icon: fontawesome/brands/github link: https://github.com/netbox-community/netbox_healthcheck_plugin name: Github - icon: material/email link: "mailto:ahanson@netboxlabs.com" # to enable disqus, uncomment the following and put your disqus id below # disqus: disqus_id # uncomment the following and put your google tracking id below to enable GA #google_analytics: #- UA-xxx #- auto 0707010000001C000041ED0000000000000000000000036614304800000000000000000000000000000000000000000000003A00000000netbox-healthcheck-plugin-0.1.4/netbox_healthcheck_plugin0707010000001D000081A4000000000000000000000001661430480000026E000000000000000000000000000000000000004600000000netbox-healthcheck-plugin-0.1.4/netbox_healthcheck_plugin/__init__.py"""Top-level package for NetBox HealthCheck Plugin.""" __author__ = """Arthur Hanson""" __email__ = 'ahanson@netboxlabs.com' __version__ = '0.1.4' from extras.plugins import PluginConfig class HealthCheckConfig(PluginConfig): name = 'netbox_healthcheck_plugin' verbose_name = 'NetBox HealthCheck Plugin' description = 'NetBox plugin for HealthCheck.' version = 'version' base_url = 'netbox_healthcheck_plugin' django_apps = [ 'health_check', 'health_check.db', 'health_check.contrib.migrations', 'health_check.contrib.redis', ] config = HealthCheckConfig 0707010000001E000081A40000000000000000000000016614304800000114000000000000000000000000000000000000004800000000netbox-healthcheck-plugin-0.1.4/netbox_healthcheck_plugin/navigation.pyfrom extras.plugins import PluginMenuButton, PluginMenuItem from utilities.choices import ButtonColorChoices menu_items = ( PluginMenuItem( link='plugins:netbox_healthcheck_plugin:healthcheck_list', link_text='HealthCheck', buttons=None ), ) 0707010000001F000041ED0000000000000000000000036614304800000000000000000000000000000000000000000000004400000000netbox-healthcheck-plugin-0.1.4/netbox_healthcheck_plugin/templates07070100000020000041ED0000000000000000000000026614304800000000000000000000000000000000000000000000005E00000000netbox-healthcheck-plugin-0.1.4/netbox_healthcheck_plugin/templates/netbox_healthcheck_plugin07070100000021000081A4000000000000000000000001661430480000076D000000000000000000000000000000000000006F00000000netbox-healthcheck-plugin-0.1.4/netbox_healthcheck_plugin/templates/netbox_healthcheck_plugin/healthcheck.html {% extends 'base/layout.html' %} {% block head %} {% endblock head %} {% block title %}Health Checks{% endblock %} {% block tabs %} <ul class="nav nav-tabs px-3"> <li class="nav-item" role="presentation"> <button class="nav-link active" id="object-list-tab" data-bs-toggle="tab" data-bs-target="#object-list" type="button" role="tab" aria-controls="edit-form" aria-selected="true"> Results {% badge table.page.paginator.count %} </button> </li> </ul> {% endblock tabs %} {% block content-wrapper %} <div class="tab-content"> {# Object list #} <div class="tab-pane show active" id="object-list" role="tabpanel" aria-labelledby="object-list-tab"> <div class="col col-md-12"> <div class="card"> <h5 class="card-header">NetBox HealthCheck Plugin</h5> <div class="card-body"> <table class="table table-striped"> <thead> <th colspan="2">Service</th> <th>Status</th> <th class="align-right">Time Taken</th> </thead> <tbody> {% for plugin in plugins %} <tr> <td class="icons"> <span aria-hidden="true"> {% if plugin.status %} ✅ {% else %} ❌ {% endif %} </span> </td> <td>{{ plugin.identifier }}</td> <td>{{ plugin.pretty_status | linebreaks }}</td> <td class="align-right">{{ plugin.time_taken|floatformat:4 }} seconds</td> </tr> {% endfor %} </tbody> </table> </div> </div> {% include 'inc/panels/custom_fields.html' %} </div> </div> </div> {% endblock content-wrapper %} 07070100000022000081A400000000000000000000000166143048000000C2000000000000000000000000000000000000004200000000netbox-healthcheck-plugin-0.1.4/netbox_healthcheck_plugin/urls.pyfrom django.conf.urls import include from django.urls import path from . import views urlpatterns = ( path('healthcheck/', views.HealthCheckListView.as_view(), name='healthcheck_list'), ) 07070100000023000081A400000000000000000000000166143048000000B6000000000000000000000000000000000000004300000000netbox-healthcheck-plugin-0.1.4/netbox_healthcheck_plugin/views.pyfrom django.views.generic import View from health_check.views import MainView class HealthCheckListView(MainView): template_name = 'netbox_healthcheck_plugin/healthcheck.html' 07070100000024000081A40000000000000000000000016614304800000599000000000000000000000000000000000000002F00000000netbox-healthcheck-plugin-0.1.4/pyproject.toml# See PEP 518 for the spec of this file # https://www.python.org/dev/peps/pep-0518/ [build-system] requires = ["setuptools"] build-backend = "setuptools.build_meta" [project] name = "netbox-healthcheck-plugin" version = "0.1.4" authors = [ {name = "Arthur Hanson", email = "ahanson@netboxlabs.com"}, ] description = "NetBox plugin for HealthCheck." readme = "README.md" classifiers=[ 'Development Status :: 3 - Alpha', 'Intended Audience :: Developers', 'Natural Language :: English', "Programming Language :: Python :: 3 :: Only", 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', 'Programming Language :: Python :: 3.11', 'Programming Language :: Python :: 3.12', ] requires-python = ">=3.8.1" dependencies = [ 'django-health-check >= 3,<4' ] [project.optional-dependencies] test = [ "black==24.3.0", "check-manifest==0.49", "flake8", "flake8-pyproject", "pre-commit==3.7.0", "pytest==8.1.1", ] [project.urls] Documentation = "https://github.com/netbox-community/netbox-healthcheck-plugin/blob/main/README.md" Source = "https://github.com/netbox-community/netbox-healthcheck-plugin" Tracker = "https://github.com/netbox-community/netbox-healthcheck-plugin/issues" [tool.black] line-length = 120 target_version = ['py39', 'py310', 'py311', 'py312'] [tool.setuptools.package-data] netbox_healthcheck_plugin = ["templates/**"] 07070100000025000081A4000000000000000000000001661430480000003B000000000000000000000000000000000000003500000000netbox-healthcheck-plugin-0.1.4/requirements_dev.txtblack==24.3.0 flake8==7.0.0 pip==24.0 check-manifest==0.49 07070100000026000041ED0000000000000000000000026614304800000000000000000000000000000000000000000000002600000000netbox-healthcheck-plugin-0.1.4/tests07070100000027000081A40000000000000000000000016614304800000037000000000000000000000000000000000000003200000000netbox-healthcheck-plugin-0.1.4/tests/__init__.py"""Unit test package for netbox_healthcheck_plugin.""" 07070100000028000081A4000000000000000000000001661430480000008D000000000000000000000000000000000000004800000000netbox-healthcheck-plugin-0.1.4/tests/test_netbox_healthcheck_plugin.py#!/usr/bin/env python """Tests for `netbox_healthcheck_plugin` package.""" from netbox_healthcheck_plugin import netbox_healthcheck_plugin 07070100000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000B00000000TRAILER!!!93 blocks
Locations
Projects
Search
Status Monitor
Help
OpenBuildService.org
Documentation
API Documentation
Code of Conduct
Contact
Support
@OBShq
Terms
openSUSE Build Service is sponsored by
The Open Build Service is an
openSUSE project
.
Sign Up
Log In
Places
Places
All Projects
Status Monitor