-
Notifications
You must be signed in to change notification settings - Fork 0
Add system metadata example #70
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add system metadata example #70
Conversation
```pwsh > poetry init This command will guide you through creating your pyproject.toml config. Package name [system]: system_example Version [0.1.0]: 0.1.0.dev0 Description []: Example demonstrating how to detect, publish, and query system hardware and software resources Author [Joe Friedrichsen <joe.friedrichsen@emerson.com>, n to skip]: n License []: MIT Compatible Python versions [>=3.11]: >=3.10 Would you like to define your main dependencies interactively? (yes/no) [yes] no Would you like to define your development dependencies interactively? (yes/no) [yes] no Generated file ```
- Authors, maintainers - Keywords, classifiers - URLs, scripts - Dependencies and tool configs
Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>
Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>
…sapi-metadata-example-ab3435917
Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request adds a new example demonstrating how to detect system hardware and software resources using the NI System Configuration API and publish that metadata to the NI Data Store.
Key Changes:
- Implements system resource detection using nisyscfg library to enumerate hardware devices and software components
- Publishes detected metadata (operator, test station, hardware items, software items) to NI Data Store
- Provides a complete example with documentation and dependencies
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| examples/system/src/system.py | Main implementation detecting system resources and publishing to data store |
| examples/system/pyproject.toml | Poetry project configuration with dependencies for nisyscfg and ni-datastore |
| examples/system/README.md | Documentation explaining the example's purpose and usage |
| examples/system/src/init.py | Package initialization with module docstring |
| examples/system/poetry.toml | Poetry configuration for virtualenv management |
| examples/system/poetry.lock | Locked dependency versions generated by Poetry |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Please add this to the example docs here |
dixonjoel
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly looks good. Waiting for a passing PR and a couple comment responses.
Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>
…https://github.com/ni/datastore-python into users/jfriedri/add-sysapi-metadata-example-ab3435917
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
It looks like only the notebooks are described on that page -- the |
Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>
Yes, that would be great if you don't mind. |
Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>
Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>
Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>
I updated the example index to include the standalone script examples. |
Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>
Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>
What does this Pull Request accomplish?
systemthatWhy should this Pull Request be merged?
What testing has been done?
poetry run mypypoetry run nps lintpoetry run system