netdoc-sdk 0.2.2__tar.gz → 0.2.4__tar.gz

netdoc_sdk-0.2.4/.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_sdk-0.2.2 → netdoc_sdk-0.2.4}/.github/workflows/cd.yml

@@ -1,13 +1,10 @@
 name: Release (CD)
-
 on:
   push:
     branches: [main]
-
 permissions:
   contents: write
   pull-requests: write
-
 jobs:
   release:
     runs-on: ubuntu-latest
@@ -20,7 +17,6 @@ jobs:
           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 }}
@@ -28,7 +24,7 @@ jobs:
     steps:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
-        with: { python-version: "3.12" }
+        with: {python-version: "3.12"}
       - run: pip install build twine
       - run: python -m build
       - run: twine upload dist/*

{netdoc_sdk-0.2.2 → netdoc_sdk-0.2.4}/.github/workflows/ci.yml

@@ -1,17 +1,13 @@
 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
@@ -20,7 +16,6 @@ jobs:
         uses: actions/checkout@v6
         with:
           path: netdoc-sdk
-
       - name: Checkout backend
         uses: actions/checkout@v6
         with:
@@ -28,47 +23,37 @@ jobs:
           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-sdk
-
       - name: Display Poetry version
         run: poetry --version
         working-directory: netdoc-sdk
-
       - name: Configure Poetry
         run: poetry config virtualenvs.in-project true
         working-directory: netdoc-sdk
-
       - name: Install
         run: make install
         working-directory: netdoc-sdk
-
       - name: Code linting (make lint)
         run: make lint
         working-directory: netdoc-sdk
-
       - name: Run checks (pre-commit)
         run: make check
         working-directory: netdoc-sdk
-
       - name: Run tests
         run: make coverage
         working-directory: netdoc-sdk
-
   snyk:
     needs: tests
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v6
-
       - name: Setup Snyk
         uses: snyk/actions/python@master
         env:

{netdoc_sdk-0.2.2 → netdoc_sdk-0.2.4}/.gitignore

@@ -413,3 +413,8 @@ htmlcov/
 # Editor-specific (already in vscode section above, but common in root)
 *.swp
 *.swo
+
+# NetDoc example files
+inventory.json
+config.yaml
+output

{netdoc_sdk-0.2.2 → netdoc_sdk-0.2.4}/.markdownlint.yaml

@@ -1,21 +1,18 @@
 # MD013 - Line length
 MD013:
-  line_length: 100
+  heading_line_length: 80
+  line_length: 10000
   code_blocks: false
   tables: false
-  strict: true
-
+  strict: false
 # 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_sdk-0.2.2 → netdoc_sdk-0.2.4}/.pre-commit-config.yaml

@@ -16,9 +16,7 @@ exclude: >-
     .*\.qcow2$|
     .*\.vma$
   )$
-
 repos:
-
   # --------------------------------------------------------------------------
   # General file hygiene
   # Handles: trailing whitespace, EOF newline, BOM, CRLF, merge conflicts,
@@ -29,13 +27,20 @@ repos:
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
-      - id: check-yaml
-      - id: check-toml
+      - 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
-
+  - repo: https://github.com/google/yamlfmt
+    rev: v0.21.0
+    hooks:
+      - id: yamlfmt
+        args: [-conf, .yamlfmt]
+        exclude: .pre-commit-config.yaml
   # --------------------------------------------------------------------------
   # Python formatting + linting (single tool, replaces black + flake8 + pyupgrade)
   # - ruff-format: drop-in replacement for black (respects pyproject.toml config)
@@ -45,22 +50,27 @@ repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.11.13
     hooks:
-    - id: ruff-check
-      name: ruff (check)
-      args: [--output-format=full]
-
+      - 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]).
+  # Config lives in 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
-
+        args: ["-c", "pyproject.toml"]
+        exclude: "tests|scripts"
   # --------------------------------------------------------------------------
   # Markdown linting.
   # Config in .markdownlint.yaml.
@@ -70,7 +80,6 @@ repos:
     hooks:
       - id: markdownlint
         args: ["--config=.markdownlint.yaml"]
-
   # --------------------------------------------------------------------------
   # Commit message: enforce Conventional Commits format.
   # Required by release-please for automatic versioning.

netdoc_sdk-0.2.4/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.2.4"
+}

netdoc_sdk-0.2.4/.yamlfmt

@@ -0,0 +1,8 @@
+formatter:
+  type: basic                     # Use the basic formatter type
+  include_document_start: false   # Do not insert '---' at the beginning of files
+  pad_line_comments: 2            # Pad comments with 2 spaces for better readability
+  indent: 2                       # Use 2 spaces for indentation (common YAML style)
+  wrap_comments: true             # Enable wrapping long comments for clarity
+  align_colons: true              # Align colons in mappings for better visual structure
+  trim_trailing_whitespace: true  # Remove trailing spaces at line ends

netdoc_sdk-0.2.4/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## [0.2.4](https://github.com/NetDocLab/netdoc-sdk/compare/v0.2.3...v0.2.4) (2026-05-30)
+
+
+### Bug Fixes
+
+* add content-type to post/put/patch methods / fix tests on collector ([a3d99d4](https://github.com/NetDocLab/netdoc-sdk/commit/a3d99d460486ff45d34496be15a013583ed6295c))
+
+## [0.2.3](https://github.com/NetDocLab/netdoc-sdk/compare/v0.2.2...v0.2.3) (2026-05-29)
+
+
+### Bug Fixes
+
+* remove metadata field and fix tests ([906f070](https://github.com/NetDocLab/netdoc-sdk/commit/906f070563397ac04148b9ec600f8e303a4063fd))
+* remove metadata from tests + improve exceptions ([36fe348](https://github.com/NetDocLab/netdoc-sdk/commit/36fe348dcc804bdf5f9676945f04f48576b777c6))

{netdoc_sdk-0.2.2 → netdoc_sdk-0.2.4}/Makefile

@@ -1,5 +1,5 @@
 # Makefile
-.PHONY: install uninstall check coverage fmt lint tests
+.PHONY: install uninstall check coverage doc fmt lint tests
 
 install:
 	poetry install --no-interaction --no-ansi
@@ -16,6 +16,9 @@ check: ## Run all pre-commit tests
 coverage: ## Run tests and show coverage report
 	poetry run pytest tests --cov=netdoc_sdk --cov-report=term-missing --cov-fail-under=80
 
+doc:  ## build the documentation into site/
+	poetry run mkdocs build --strict
+
 fmt: ## Code formatting
 	poetry run ruff format .
 	poetry run ruff check --fix

{netdoc_sdk-0.2.2 → netdoc_sdk-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netdoc-sdk
-Version: 0.2.2
+Version: 0.2.4
 Summary: Network Documentation Platform - SDK
 Project-URL: homepage, https://github.com/NetDocLab/netdoc-sdk
 Project-URL: documentation, https://github.com/NetDocLab/netdoc-sdk/wiki