You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-6Lines changed: 19 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,13 @@
2
2
3
3
Diode SDK Python is a Python library for interacting with the Diode ingestion service utilizing gRPC.
4
4
5
-
Diode is a new [NetBox](https://netboxlabs.com/oss/netbox/) ingestion service that greatly simplifies and enhances the process to add and update network data
5
+
Diode is a new [NetBox](https://netboxlabs.com/oss/netbox/) ingestion service that greatly simplifies and enhances the
6
+
process to add and update network data
6
7
in NetBox, ensuring your network source of truth is always accurate and can be trusted to power your network automation
7
8
pipelines.
8
9
9
-
More information about Diode can be found at [https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in-netbox/](https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in-netbox/).
10
+
More information about Diode can be found
11
+
at [https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in-netbox/](https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in-netbox/).
10
12
11
13
## Installation
12
14
@@ -35,10 +37,10 @@ from netboxlabs.diode.sdk.ingester import (
35
37
36
38
defmain():
37
39
with DiodeClient(
38
-
target="localhost:8081",
39
-
app_name="my-test-app",
40
-
app_version="0.0.1",
41
-
tls_verify=False,
40
+
target="localhost:8081",
41
+
app_name="my-test-app",
42
+
app_version="0.0.1",
43
+
tls_verify=False,
42
44
) as client:
43
45
entities = []
44
46
@@ -85,11 +87,22 @@ if __name__ == "__main__":
85
87
86
88
## Development notes
87
89
90
+
Code in `netboxlabs/diode/sdk/diode/*` are generated from Protocol Buffers definitions (will be published and referred
91
+
here soon).
92
+
93
+
#### Linting
94
+
88
95
```shell
89
96
ruff netboxlabs/
90
97
black netboxlabs/
91
98
```
92
99
100
+
#### Testing
101
+
102
+
```shell
103
+
pytest tests/
104
+
```
105
+
93
106
## License
94
107
95
108
Distributed under the Apache 2.0 License. See [LICENSE.txt](./LICENSE.txt) for more information.
0 commit comments