Skip to content

Commit 700e430

Browse files
committed
fix: README - tidy up development notes
Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>
1 parent 4974992 commit 700e430

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Diode SDK Python is a Python library for interacting with the Diode ingestion service utilizing gRPC.
44

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
67
in NetBox, ensuring your network source of truth is always accurate and can be trusted to power your network automation
78
pipelines.
89

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/).
1012

1113
## Installation
1214

@@ -35,10 +37,10 @@ from netboxlabs.diode.sdk.ingester import (
3537

3638
def main():
3739
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,
4244
) as client:
4345
entities = []
4446

@@ -85,11 +87,22 @@ if __name__ == "__main__":
8587

8688
## Development notes
8789

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+
8895
```shell
8996
ruff netboxlabs/
9097
black netboxlabs/
9198
```
9299

100+
#### Testing
101+
102+
```shell
103+
pytest tests/
104+
```
105+
93106
## License
94107

95108
Distributed under the Apache 2.0 License. See [LICENSE.txt](./LICENSE.txt) for more information.

0 commit comments

Comments
 (0)