{"id":23769787,"url":"https://github.com/ni/vscode-ni-python-dataplugins","last_synced_at":"2025-09-05T14:33:00.160Z","repository":{"id":42854465,"uuid":"252972786","full_name":"ni/vscode-ni-python-dataplugins","owner":"ni","description":"NI DataPlugins extension for Visual Studio Code","archived":false,"fork":false,"pushed_at":"2023-07-19T02:44:09.000Z","size":1497,"stargazers_count":4,"open_issues_count":7,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-15T01:28:57.969Z","etag":null,"topics":["national-instruments","ni-dataplugins","python","vscode-extension","vsix"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ni.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2020-04-04T10:57:35.000Z","updated_at":"2022-08-14T09:18:09.000Z","dependencies_parsed_at":"2023-02-08T03:45:16.104Z","dependency_job_id":null,"html_url":"https://github.com/ni/vscode-ni-python-dataplugins","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ni%2Fvscode-ni-python-dataplugins","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ni%2Fvscode-ni-python-dataplugins/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ni%2Fvscode-ni-python-dataplugins/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ni%2Fvscode-ni-python-dataplugins/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ni","download_url":"https://codeload.github.com/ni/vscode-ni-python-dataplugins/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232044694,"owners_count":18464623,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["national-instruments","ni-dataplugins","python","vscode-extension","vsix"],"created_at":"2025-01-01T02:32:24.889Z","updated_at":"2025-01-01T02:32:25.929Z","avatar_url":"https://github.com/ni.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NI DataPlugins Extension for Visual Studio Code\n\nA [Visual Studio Code](https://code.visualstudio.com/) extension that provides development support for [NI DataPlugins](https://www.ni.com/downloads/dataplugins) written in [Python](https://www.python.org). For more information about writing Python DataPlugins, please refer to the [SystemLink Operations Handbook](https://operations.systemlink.io/python-dataplugins/python-dataplugins).\n\n![CI](https://github.com/ni/vscode-ni-python-dataplugins/workflows/CI/badge.svg)\n\n## Quick Start\n\n**Step 1.** Install this extension. Download from [marketplace](https://marketplace.visualstudio.com/items?itemName=ni.vscode-ni-python-dataplugins) or download the latest *vsix* from [Release](https://github.com/jschumme/vscode-ni-python-dataplugins/releases).\n\n- Open Visual Studio Code and select __View__-\u003e__Extensions__ from the menu to display the __Extensions__ pane.\n- Click the __...__ in the top-right corner of the __Extensions__ pane and select __Install from VSIX__.\n- Locate the .vsix file you download and click __Open__.\n- Click __Restart__ to confirm.\n\n![Installing the extension](./docs/images/install-from-vsix.png)\n\n**Step 2.** Create a new DataPlugin. Launch __VSCode Command Palette__ (Ctrl+Shift+P), paste the command below, and press __Enter__.\n\n```json\nNI DataPlugins: Create new Python-DataPlugin\n```\n\n![Creating a new DataPlugin](./docs/images/create-new-dataplugin.gif)\n\n**Step 3.** Export the DataPlugin. Right-click the \\*.py file you want to export.\n\n- __NI DataPlugins: Export DataPlugin__: Your code will be embedded in a *.uri file that you can share with others.\n- __NI DataPlugins: Register DataPlugin for Development__ (CTRL+ALT+F5): Use this option to register the DataPlugin exclusively on your development machine and test your code changes in DIAdem, LabVIEW, or SystemLink.\n\n## Snippets\n\nThis extension defines a few helpful __Snippets__ that extend the auto-completion capabilities of VSCode. Start typing and press __Ctrl+Space__ to display a list of suggestions.\n\nUse the following __Snippets__ to quickly select a supported data type:\n\n- `DataTypeChnFloat32`\n- `DataTypeChnFloat64`\n- `DataTypeChnString`\n- `DataTypeChnDate`\n- `DataTypeChnUInt8`\n- `DataTypeChnInt16`\n- `DataTypeChnInt32`\n- `DataTypeChnInt64`\n\nUse the following __Snippets__ to insert the most common stubs:\n\n- `if __name__ == \"__main__\"`\n- `def read_channel_length`\n- `def read_channel_values`\n- `def read_store`\n\nFeel free to __contribute__ additional __Snippets__ to the project: [snippets/snippets.json](./snippets/snippets.json)\n\n## Advanced Settings\n\n### Custom Template\n\nStart writing your DataPlugin with your own custom template. Simply add your template to the `examples` directory. You find the examples folder at `$HOME/.vscode/extensions/ni.vscode-ni-python-dataplugins-\u003cversion\u003e` under Mac and Linux or at `%USERPROFILE%\\.vscode\\extensions\\ni.vscode-ni-python-dataplugins-\u003cversion\u003e` folder under Windows.\n\n### .file-extensions\n\nCreate a file `.file-extensions` in the root directory of your project and list all file extensions that you want your DataPlugin to support. If no list is defined, you will be prompted to provide a list of file extensions when you export your DataPlugin.\n\n### Export Path\n\nSet the export path for all your plugins in __Preferences -\u003e Settings -\u003e Extensions -\u003e Python DataPlugins -\u003e Export Path__. The path can be a folder or a *.uri file.\n\n\u003cdetails\u003e\n\u003csummary\u003eExample\u003c/summary\u003e\n\n```json\n{\n    \"Python-DataPlugins.exportPath\": \"C:\\\\Temp\"\n}\n// OR\n{\n    \"Python-DataPlugins.exportPath\": \"C:\\\\Temp\\\\MyPlugin.uri\"\n}\n```\n\n\u003c/details\u003e\n\n## Contribute\n\nContribute to this project by finding issues, requesting features or creating Pull Requests. General documentation about developing extensions for Visual Studio Code can be found [here](https://code.visualstudio.com/api) and [here](https://vscode-docs.readthedocs.io/en/stable/extensions/debugging-extensions/).\n\n### Developer Setup\n\nTo compile this extension, run:\n\n```sh\ngit clone https://github.com/ni/vscode-ni-python-dataplugins.git\ncd vscode-ni-python-dataplugins\nnpm install\n```\n\nTo test your changes, run:\n\n```sh\nnpm run lint\nnpm run test\nnpm run test:e2e\n```\n\nRun the extension from VSCode by pressing `F5`.\n\n## License\n\nSee [LICENSE](https://github.com/ni/vscode-ni-python-dataplugins/blob/master/LICENSE) for details about how this extension is licensed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fni%2Fvscode-ni-python-dataplugins","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fni%2Fvscode-ni-python-dataplugins","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fni%2Fvscode-ni-python-dataplugins/lists"}