Skip to content

Commit 6f7070d

Browse files
authored
feat: diode-sdk-python 1.0.0-rc (#45)
2 parents a446fe7 + 2dccc83 commit 6f7070d

File tree

10 files changed

+9596
-1119
lines changed

10 files changed

+9596
-1119
lines changed

.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,5 @@ __pycache__/
2424
build/
2525
dist/
2626
.eggs/
27-
*.egg-info
27+
*.egg-info
28+
poetry.lock

README.md

+88-19
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ pip install netboxlabs-diode-sdk
2020

2121
### Environment variables
2222

23-
* `DIODE_API_KEY` - API key for the Diode service
2423
* `DIODE_SDK_LOG_LEVEL` - Log level for the SDK (default: `INFO`)
2524
* `DIODE_SENTRY_DSN` - Optional Sentry DSN for error reporting
25+
* `DIODE_CLIENT_ID` - Client ID for OAuth2 authentication
26+
* `DIODE_CLIENT_SECRET` - Client Secret for OAuth2 authentication
2627

2728
### Example
2829

@@ -76,26 +77,94 @@ if __name__ == "__main__":
7677

7778
## Supported entities (object types)
7879

79-
* [Device](./docs/entities.md#device)
80-
* [Interface](./docs/entities.md#interface)
81-
* [Device Type](./docs/entities.md#device-type)
82-
* [Platform](./docs/entities.md#platform)
83-
* [Manufacturer](./docs/entities.md#manufacturer)
84-
* [Site](./docs/entities.md#site)
85-
* [Role](./docs/entities.md#role)
86-
* [IP Address](./docs/entities.md#ip-address)
87-
* [Prefix](./docs/entities.md#prefix)
88-
* [Cluster Group](./docs/entities.md#cluster-group)
89-
* [Cluster Type](./docs/entities.md#cluster-type)
90-
* [Cluster](./docs/entities.md#cluster)
91-
* [Virtual Machine](./docs/entities.md#virtual-machine)
92-
* [Virtual Disk](./docs/entities.md#virtual-disk)
93-
* [VM Interface](./docs/entities.md#vm-interface)
80+
* ASN
81+
* ASN Range
82+
* Aggregate
83+
* Circuit
84+
* Circuit Group
85+
* Circuit Group Assignment
86+
* Circuit Termination
87+
* Circuit Type
88+
* Cluster
89+
* Cluster Group
90+
* Cluster Type
91+
* Console Port
92+
* Console Server Port
93+
* Contact
94+
* Contact Assignment
95+
* Contact Group
96+
* Contact Role
97+
* Device
98+
* Device Bay
99+
* Device Role
100+
* Device Type
101+
* FHRP Group
102+
* FHRP Group Assignment
103+
* Front Port
104+
* IKE Policy
105+
* IKE Proposal
106+
* IP Address
107+
* IP Range
108+
* IP Sec Policy
109+
* IP Sec Profile
110+
* IP Sec Proposal
111+
* Interface
112+
* Inventory Item
113+
* Inventory Item Role
114+
* L2VPN
115+
* L2VPN Termination
116+
* Location
117+
* MAC Address
118+
* Manufacturer
119+
* Module
120+
* Module Bay
121+
* Module Type
122+
* Platform
123+
* Power Feed
124+
* Power Outlet
125+
* Power Panel
126+
* Power Port
127+
* Prefix
128+
* Provider
129+
* Provider Account
130+
* Provider Network
131+
* RIR
132+
* Rack
133+
* Rack Role
134+
* Rack Type
135+
* Rear Port
136+
* Region
137+
* Role
138+
* Route Target
139+
* Service
140+
* Site
141+
* Site Group
142+
* Tag
143+
* Tenant
144+
* Tenant Group
145+
* Tunnel
146+
* Tunnel Group
147+
* Tunnel Termination
148+
* VLAN
149+
* VLAN Group
150+
* VLAN Translation Policy
151+
* VLAN Translation Rule
152+
* VM Interface
153+
* VRF
154+
* Virtual Chassis
155+
* Virtual Circuit
156+
* Virtual Circuit Termination
157+
* Virtual Circuit Type
158+
* Virtual Device Context
159+
* Virtual Disk
160+
* Virtual Machine
161+
* Wireless Lan
162+
* Wireless Lan Group
163+
* Wireless Link
94164

95165
## Development notes
96166

97-
Code in `netboxlabs/diode/sdk/diode/*` is generated from Protocol Buffers definitions (will be published and referred
98-
here soon).
167+
Code in `netboxlabs/diode/sdk/diode/*` is generated from Protocol Buffers definitions (will be published and referenced here soon).
99168

100169
#### Linting
101170

@@ -107,7 +176,7 @@ black netboxlabs/
107176
#### Testing
108177

109178
```shell
110-
pytest tests/
179+
PYTHONPATH=$(pwd) pytest
111180
```
112181

113182
## License

0 commit comments

Comments
 (0)