🚀 release: 1.0.0 (#46)

Author: mfiedorowicz

.github/CODEOWNERS

@@ -1 +1 @@
-*                     @leoparente @mfiedorowicz
+*                     @leoparente @ltucker @mfiedorowicz

.github/workflows/lint-tests.yml

@@ -43,7 +43,7 @@ jobs:
           pytest --junitxml=pytest.xml --cov-report=term-missing:skip-covered --cov=netboxlabs.diode.sdk tests/ | tee pytest-coverage.txt
 
       - name: Pytest coverage comment
-        uses: MishaKav/pytest-coverage-comment@main
+        uses: MishaKav/pytest-coverage-comment@81882822c5b22af01f91bd3eacb1cefb6ad73dc2 # v1
         with:
           pytest-coverage-path: ./pytest-coverage.txt
           junitxml-path: ./pytest.xml

.github/workflows/release.yaml

@@ -44,7 +44,7 @@ jobs:
         with:
           node-version: "lts/*"
       - name: Write package.json
-        uses: DamianReeves/write-file-action@master
+        uses: DamianReeves/write-file-action@6929a9a6d1807689191dcc8bbe62b54d70a32b42 # v1.3
         with:
           path: ./package.json
           write-mode: overwrite
@@ -58,7 +58,7 @@ jobs:
               }
             }
       - name: Write .releaserc.json
-        uses: DamianReeves/write-file-action@master
+        uses: DamianReeves/write-file-action@6929a9a6d1807689191dcc8bbe62b54d70a32b42 # v1.3
         with:
           path: ./.releaserc.json
           write-mode: overwrite
@@ -168,7 +168,7 @@ jobs:
           retention-days: 30
           if-no-files-found: error
       - name: Publish release distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
+        uses: pypa/gh-action-pypi-publish@67339c736fd9354cd4f8cb0b744f2b82a74b5c70 # v.1.12.3
         with:
           packages-dir: dist
 
@@ -183,7 +183,7 @@ jobs:
         with:
           node-version: "lts/*"
       - name: Write package.json
-        uses: DamianReeves/write-file-action@master
+        uses: DamianReeves/write-file-action@6929a9a6d1807689191dcc8bbe62b54d70a32b42 # v1.3
         with:
           path: ./package.json
           write-mode: overwrite
@@ -197,7 +197,7 @@ jobs:
               }
             }
       - name: Write .releaserc.json
-        uses: DamianReeves/write-file-action@master
+        uses: DamianReeves/write-file-action@6929a9a6d1807689191dcc8bbe62b54d70a32b42 # v1.3
         with:
           path: ./.releaserc.json
           write-mode: overwrite

.gitignore

@@ -24,4 +24,5 @@ __pycache__/
 build/
 dist/
 .eggs/
-*.egg-info
+*.egg-info
+poetry.lock

README.md

@@ -20,9 +20,10 @@ pip install netboxlabs-diode-sdk
 
 ### Environment variables
 
-* `DIODE_API_KEY` - API key for the Diode service
 * `DIODE_SDK_LOG_LEVEL` - Log level for the SDK (default: `INFO`)
 * `DIODE_SENTRY_DSN` - Optional Sentry DSN for error reporting
+* `DIODE_CLIENT_ID` - Client ID for OAuth2 authentication
+* `DIODE_CLIENT_SECRET` - Client Secret for OAuth2 authentication
 
 ### Example
 
@@ -76,26 +77,94 @@ if __name__ == "__main__":
 
 ## Supported entities (object types)
 
-* [Device](./docs/entities.md#device)
-* [Interface](./docs/entities.md#interface)
-* [Device Type](./docs/entities.md#device-type)
-* [Platform](./docs/entities.md#platform)
-* [Manufacturer](./docs/entities.md#manufacturer)
-* [Site](./docs/entities.md#site)
-* [Role](./docs/entities.md#role)
-* [IP Address](./docs/entities.md#ip-address)
-* [Prefix](./docs/entities.md#prefix)
-* [Cluster Group](./docs/entities.md#cluster-group)
-* [Cluster Type](./docs/entities.md#cluster-type)
-* [Cluster](./docs/entities.md#cluster)
-* [Virtual Machine](./docs/entities.md#virtual-machine)
-* [Virtual Disk](./docs/entities.md#virtual-disk)
-* [VM Interface](./docs/entities.md#vm-interface)
+* ASN
+* ASN Range
+* Aggregate
+* Circuit
+* Circuit Group
+* Circuit Group Assignment
+* Circuit Termination
+* Circuit Type
+* Cluster
+* Cluster Group
+* Cluster Type
+* Console Port
+* Console Server Port
+* Contact
+* Contact Assignment
+* Contact Group
+* Contact Role
+* Device
+* Device Bay
+* Device Role
+* Device Type
+* FHRP Group
+* FHRP Group Assignment
+* Front Port
+* IKE Policy
+* IKE Proposal
+* IP Address
+* IP Range
+* IP Sec Policy
+* IP Sec Profile
+* IP Sec Proposal
+* Interface
+* Inventory Item
+* Inventory Item Role
+* L2VPN
+* L2VPN Termination
+* Location
+* MAC Address
+* Manufacturer
+* Module
+* Module Bay
+* Module Type
+* Platform
+* Power Feed
+* Power Outlet
+* Power Panel
+* Power Port
+* Prefix
+* Provider
+* Provider Account
+* Provider Network
+* RIR
+* Rack
+* Rack Role
+* Rack Type
+* Rear Port
+* Region
+* Role
+* Route Target
+* Service
+* Site
+* Site Group
+* Tag
+* Tenant
+* Tenant Group
+* Tunnel
+* Tunnel Group
+* Tunnel Termination
+* VLAN
+* VLAN Group
+* VLAN Translation Policy
+* VLAN Translation Rule
+* VM Interface
+* VRF
+* Virtual Chassis
+* Virtual Circuit
+* Virtual Circuit Termination
+* Virtual Circuit Type
+* Virtual Device Context
+* Virtual Disk
+* Virtual Machine
+* Wireless Lan
+* Wireless Lan Group
+* Wireless Link
 
 ## Development notes
 
-Code in `netboxlabs/diode/sdk/diode/*` is generated from Protocol Buffers definitions (will be published and referred
-here soon).
+Code in `netboxlabs/diode/sdk/diode/*` is generated from Protocol Buffers definitions (will be published and referenced here soon).
 
 #### Linting
 
@@ -107,7 +176,7 @@ black netboxlabs/
 #### Testing
 
 ```shell
-pytest tests/
+PYTHONPATH=$(pwd) pytest
 ```
 
 ## License