netdoc-collector 0.2.1__tar.gz

netdoc_collector-0.2.1/.editorconfig

@@ -0,0 +1,33 @@
+# EditorConfig is awesome: https://editorconfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.{js,py}]
+charset = utf-8
+
+# 4 space indentation
+[*.py]
+indent_style = space
+indent_size = 4
+
+# Tab indentation (no size specified)
+[Makefile]
+indent_style = tab
+
+# Indentation override for all JS under lib directory
+[lib/**.js]
+indent_style = space
+indent_size = 2
+
+# Matches the exact files either package.json or .travis.yml
+[{package.json,.travis.yml}]
+indent_style = space
+indent_size = 2

netdoc_collector-0.2.1/.flake8

@@ -0,0 +1,8 @@
+[flake8]
+exclude = __pycache__|.git|.venv|.vscode|build|dist|env|fonts|migrations|venv
+# Ignore C901: Function is too complex
+# Ignore E501: Line too long (82 > 79 characters)
+# Ignore W503: Line break occurred before a binary operator
+ignore = C901, E501, W503
+max-complexity = 10
+max-line-length = 120

netdoc_collector-0.2.1/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# Default owner(s) of all files in this repository
+* @AndreaCavazzini
+* @dainok

netdoc_collector-0.2.1/.github/workflows/cd.yml

@@ -0,0 +1,37 @@
+name: Release (CD)
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+    steps:
+      - uses: googleapis/release-please-action@v5
+        id: release
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          config-file: release-please-config.json
+          manifest-file: .release-please-manifest.json
+
+  publish:
+    needs: release
+    if: ${{ needs.release.outputs.release_created }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with: { python-version: "3.12" }
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}

netdoc_collector-0.2.1/.github/workflows/ci.yml

@@ -0,0 +1,77 @@
+name: Tests (CI)
+
+env:
+  PYTHON_VERSION: 3.12
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+# Cancel any existing runs of this workflow for this same branch
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          path: netdoc-collector
+
+      - name: Checkout backend
+        uses: actions/checkout@v6
+        with:
+          repository: NetDocLab/netdoc
+          path: netdoc
+          # Permission -> Content
+          token: ${{ secrets.NETDOC_REPO_TOKEN }}
+
+      - name: Setup Python3
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install Poetry
+        run: pip install --no-cache-dir poetry
+        working-directory: netdoc-collector
+
+      - name: Display Poetry version
+        run: poetry --version
+        working-directory: netdoc-collector
+
+      - name: Configure Poetry
+        run: poetry config virtualenvs.in-project true
+        working-directory: netdoc-collector
+
+      - name: Install
+        run: make install
+        working-directory: netdoc-collector
+
+      - name: Code linting (make lint)
+        run: make lint
+        working-directory: netdoc-collector
+
+      - name: Run checks (pre-commit)
+        run: make check
+        working-directory: netdoc-collector
+
+      - name: Run tests
+        run: make coverage
+        working-directory: netdoc-collector
+
+  snyk:
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Snyk
+        uses: snyk/actions/python@master
+        env:
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+        with:
+          args: --severity-threshold=high

netdoc_collector-0.2.1/.gitignore

@@ -0,0 +1,420 @@
+#############################################################################
+# https://github.com/github/gitignore/blob/main/Python.gitignore
+#############################################################################
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+#############################################################################
+# 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
+!*.code-workspace
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+#############################################################################
+# https://github.com/github/gitignore/blob/main/Global/macOS.gitignore
+#############################################################################
+
+# General
+.DS_Store
+__MACOSX/
+.AppleDouble
+.LSOverride
+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/Linux.gitignore
+#############################################################################
+
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# Metadata left by Dolphin file manager, which comes with KDE Plasma
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+# Log files created by default by the nohup command
+nohup.out
+
+#############################################################################
+# https://github.com/github/gitignore/blob/main/Terraform.gitignore
+#############################################################################
+
+# Local .terraform directories
+.terraform/
+
+# .tfstate files
+# *.tfstate
+# *.tfstate.*
+
+# Crash log files
+crash.log
+crash.*.log
+
+# Exclude all .tfvars files, which are likely to contain sensitive data, such as
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
+# to change depending on the environment.
+*.tfvars
+*.tfvars.json
+
+# Ignore override files as they are usually used to override resources locally and so
+# are not checked in
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
+
+# Ignore transient lock info files created by terraform apply
+.terraform.tfstate.lock.info
+
+# Include override files you do wish to add to version control using negated pattern
+# !example_override.tf
+
+# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
+# example: *tfplan*
+
+# Ignore CLI configuration files
+.terraformrc
+terraform.rc
+
+# Optional: ignore graph output files generated by `terraform graph`
+# *.dot
+
+# Optional: ignore plan files saved before destroying Terraform configuration
+# Uncomment the line below if you want to ignore planout files.
+# planout
+
+#############################################################################
+# https://github.com/github/gitignore/blob/main/Global/MicrosoftOffice.gitignore
+#############################################################################
+
+*.tmp
+
+# Word temporary
+~$*.doc*
+~$*.dot*
+
+# Word Auto Backup File
+Backup of *.doc*
+
+# Excel temporary
+~$*.xls*
+
+# Excel Backup File
+*.xlk
+
+# PowerPoint temporary
+~$*.ppt*
+
+# Visio autosave temporary files
+*.~vsd*
+
+#############################################################################
+# https://github.com/github/gitignore/blob/main/community/Obsidian/NotesAndCoreConfiguration.gitignore
+#############################################################################
+
+# Excludes Obsidian workspace cache and plugins. All notes and core obsidian
+# configuration files are tracked by Git.
+
+# The current application UI state (DOM layout, recently-opened files, etc.) is
+# stored in these files (separate for desktop and mobile) so you can resume
+# your session seamlessly after a restart. If you want to track UI state, use
+# the Workspaces core plugin instead of relying on these files.
+.obsidian/workspace.json
+.obsidian/workspace-mobile.json
+
+# Obsidian plugins are stored under .obsidian/plugins/$plugin_name. They
+# contain metadata (manifest.json), application code (main.js), stylesheets
+# (styles.css), and user-configuration data (data.json).
+# We want to exclude all plugin-related files, so we can exclude everything
+# under this directory.
+.obsidian/plugins/**/*
+
+#############################################################################
+# Custom
+#############################################################################
+
+# Build artifacts and security outputs
+artifacts/
+sbom-cyclonedx.json
+
+# Secret files (never commit these)
+secrets.json
+secrets.txt
+secrets.yaml
+secrets.yml
+secrets.sh
+
+# Release tarballs created locally
+/*.tar.gz
+
+# Coverage and test outputs (already partially covered above, explicit here)
+.coverage
+coverage.xml
+htmlcov/
+
+# pre-commit cache (local only, no value in version control)
+.pre-commit-cache/
+
+# Distribution metadata generated during local builds
+*.dist-info/
+
+# Editor-specific (already in vscode section above, but common in root)
+*.swp
+*.swo
+
+# NetDoc example files
+inventory.json
+config.yaml
+output

netdoc_collector-0.2.1/.markdownlint.yaml

@@ -0,0 +1,21 @@
+# MD013 - Line length
+MD013:
+  line_length: 100
+  code_blocks: false
+  tables: false
+  strict: true
+
+# MD024 - No duplicate headings (useful in changelogs where ## Added repeats)
+MD024:
+  siblings_only: true  # allows duplicate headings in different sections
+
+# MD033 - No inline HTML (keep markdown portable)
+MD033: false  # set to true if you want to forbid <br>, <details> etc.
+
+# MD046 - Code block style: enforce fenced blocks (```) over indented
+MD046:
+  style: fenced
+
+# MD048 - Code fence style: enforce backticks over tildes
+MD048:
+  style: backtick

netdoc_collector-0.2.1/.pre-commit-config.yaml

@@ -0,0 +1,93 @@
+# Global excludes: apply to every hook unless overridden at hook level.
+# Keep in sync with [tool.ruff] exclude in pyproject.toml.
+exclude: >-
+  (?x)^(
+    __pycache__/.*|
+    \.git/.*|
+    \.venv/.*|
+    \.vscode/.*|
+    build/.*|
+    dist/.*|
+    env/.*|
+    venv/.*|
+    migrations/.*|
+    fonts/.*|
+    \.secrets\.baseline$|
+    .*\.qcow2$|
+    .*\.vma$
+  )$
+
+repos:
+  # --------------------------------------------------------------------------
+  # General file hygiene
+  # Handles: trailing whitespace, EOF newline, BOM, CRLF, merge conflicts,
+  #          large files, case conflicts, JSON/YAML/TOML syntax.
+  # --------------------------------------------------------------------------
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+        args: [--allow-multiple-documents]
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  # --------------------------------------------------------------------------
+  # Python formatting + linting (single tool, replaces black + flake8 + pyupgrade)
+  # - ruff-format: drop-in replacement for black (respects pyproject.toml config)
+  # - ruff check:  covers flake8 (E/F/W), isort (I), pyupgrade (UP), bugbear (B)
+  #                and more — all configured in [tool.ruff.lint] in pyproject.toml
+  # --------------------------------------------------------------------------
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.13
+    hooks:
+      - id: ruff-check
+        name: ruff (check)
+        args: [--output-format=full]
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: python-check-blanket-noqa
+      - id: python-no-eval
+      - id: text-unicode-replacement-char
+      - id: python-use-type-annotations
+
+  # --------------------------------------------------------------------------
+  # Security: static analysis for common vulnerabilities.
+  # Ruff has partial coverage (S ruleset) but bandit is more thorough.
+  # Config lives in .bandit.yaml (or pyproject.toml [tool.bandit]).
+  # --------------------------------------------------------------------------
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.9.4
+    hooks:
+      - id: bandit
+        args: ["-c", "pyproject.toml"] # prefer pyproject.toml over .bandit.yaml
+        exclude: ^tests/ # asserts and test patterns are expected
+
+  # --------------------------------------------------------------------------
+  # Markdown linting.
+  # Config in .markdownlint.yaml.
+  # --------------------------------------------------------------------------
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.45.0
+    hooks:
+      - id: markdownlint
+        args: ["--config=.markdownlint.yaml"]
+
+  # --------------------------------------------------------------------------
+  # Commit message: enforce Conventional Commits format.
+  # Required by release-please for automatic versioning.
+  # Allowed types: feat fix chore docs refactor test ci build perf
+  # --------------------------------------------------------------------------
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v4.0.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: [feat, fix, chore, docs, refactor, test, ci, build, perf]