crestron-nvx 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,27 @@
1
+ # Changelog
2
+
3
+ This project follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
4
+ and uses semantic versioning.
5
+
6
+ ## [Unreleased]
7
+
8
+ ## [0.1.0] - 2026-09-13
9
+
10
+ ### Added
11
+
12
+ - Initial read-only async client and typed immutable snapshot models.
13
+ - HTTPS authentication with isolated cookie handling and one reauthentication
14
+ attempt after session expiry.
15
+ - Field-driven parsing for DM-NVX-350, DM-NVX-360, and DM-NVX-E30 devices on
16
+ the declared firmware 6.0 and 7.1 support baseline.
17
+ - Synthetic tests, strict typing, linting, coverage enforcement, packaging, and
18
+ trusted-publishing workflow.
19
+ - Bounded JSON response reads and endpoint-controlled collections.
20
+ - Complete source distribution with tests and project documentation.
21
+
22
+ ### Security
23
+
24
+ - Keep the authentication bootstrap on the configured endpoint by disabling
25
+ automatic HTTP redirects.
26
+ - Document the credential-interception risk when callers disable certificate
27
+ verification for self-signed endpoints.
@@ -0,0 +1,21 @@
1
+ # Contributing
2
+
3
+ Contributions are welcome when they preserve the library's async, typed, and
4
+ device-agnostic API boundary.
5
+
6
+ Before opening a pull request:
7
+
8
+ 1. Add or update focused tests.
9
+ 2. Run Ruff formatting and linting, mypy, pytest with coverage, and the package
10
+ build checks documented in the README.
11
+ 3. Update the changelog for user-visible behaviour.
12
+ 4. Keep the client independent of Home Assistant and other consumers.
13
+
14
+ Do not commit raw device responses, packet captures, credentials, cookies,
15
+ serial numbers, MAC addresses, stream addresses, user-assigned names, copied
16
+ vendor documentation, private SDK content, firmware, or decompiled material.
17
+ Use invented values and the smallest payload needed for each test. See
18
+ [API_PROVENANCE.md](docs/API_PROVENANCE.md).
19
+
20
+ Write/control operations require separate review, explicit tests for failure
21
+ and authentication behaviour, and documentation of their device-side effects.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,5 @@
1
+ include CHANGELOG.md
2
+ include CONTRIBUTING.md
3
+ include SECURITY.md
4
+ recursive-include docs *.md
5
+ recursive-include tests *.py
@@ -0,0 +1,9 @@
1
+ crestron-nvx
2
+ Copyright 2026 Daniel Wilson and contributors
3
+
4
+ This is an independent, unofficial community project and is not affiliated
5
+ with, endorsed by, sponsored by, or supported by Crestron Electronics, Inc.
6
+
7
+ Crestron, DigitalMedia, DM, DM NVX, and related names and marks are trademarks
8
+ or registered trademarks of Crestron Electronics, Inc. in the United States
9
+ and/or other countries. Their use identifies compatible products only.
@@ -0,0 +1,157 @@
1
+ Metadata-Version: 2.4
2
+ Name: crestron-nvx
3
+ Version: 0.1.0
4
+ Summary: Unofficial async Python client for Crestron DM NVX devices
5
+ Author: Dan Wilson
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Documentation, https://github.com/Danw33/py-crestron-nvx#readme
8
+ Project-URL: Issues, https://github.com/Danw33/py-crestron-nvx/issues
9
+ Project-URL: Source, https://github.com/Danw33/py-crestron-nvx
10
+ Keywords: crestron,dm-nvx,av-over-ip,asyncio
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Framework :: AsyncIO
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3 :: Only
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Programming Language :: Python :: 3.14
21
+ Classifier: Typing :: Typed
22
+ Requires-Python: >=3.11
23
+ Description-Content-Type: text/markdown
24
+ License-File: LICENSE
25
+ License-File: NOTICE
26
+ Requires-Dist: aiohttp>=3.9.0
27
+ Requires-Dist: yarl>=1.9.4
28
+ Provides-Extra: test
29
+ Requires-Dist: build>=1.2.2; extra == "test"
30
+ Requires-Dist: mypy>=1.15.0; extra == "test"
31
+ Requires-Dist: pytest>=8.3.0; extra == "test"
32
+ Requires-Dist: pytest-asyncio>=0.25.0; extra == "test"
33
+ Requires-Dist: pytest-cov>=6.0.0; extra == "test"
34
+ Requires-Dist: ruff>=0.9.0; extra == "test"
35
+ Requires-Dist: twine>=6.1.0; extra == "test"
36
+ Dynamic: license-file
37
+
38
+ # crestron-nvx
39
+
40
+ [![CI](https://github.com/Danw33/py-crestron-nvx/actions/workflows/ci.yml/badge.svg)](https://github.com/Danw33/py-crestron-nvx/actions/workflows/ci.yml)
41
+ [![Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
42
+
43
+ An **unofficial** async Python client for direct local communication with
44
+ Crestron DM NVX AV-over-IP endpoints.
45
+
46
+ > [!IMPORTANT]
47
+ > This is an independent, unofficial community project. It is not affiliated
48
+ > with, endorsed by, sponsored by, or supported by Crestron Electronics, Inc.
49
+ > Crestron, DigitalMedia, DM, DM NVX, and related names and marks are trademarks
50
+ > or registered trademarks of Crestron Electronics, Inc. in the United States
51
+ > and/or other countries. Their use here identifies compatible products only.
52
+ > Do not contact Crestron support for help with this library.
53
+
54
+ ## API provenance
55
+
56
+ This library implements Crestron's ** publicly documented DM NVX REST API**.
57
+ The authoritative external references are Crestron's public:
58
+
59
+ - [DM NVX REST API reference](https://sdkcon78221.crestron.com/sdk/DM_NVX_REST_API/Content/Topics/API-Reference.htm)
60
+ - [DM NVX API authentication guide](https://sdkcon78221.crestron.com/sdk/DM_NVX_REST_API/Content/Topics/Authentication.htm)
61
+
62
+ Those references describe the API's HTTPS authentication, GET/POST methods,
63
+ object paths, property types, and model-specific applicability. This repository
64
+ does not copy or redistribute Crestron manuals, schemas, examples, firmware, or
65
+ other proprietary material. The external documentation and device behaviour
66
+ may change, and continued compatibility is not guaranteed.
67
+
68
+ See [API_PROVENANCE.md](docs/API_PROVENANCE.md) for the project's source and
69
+ fixture policy.
70
+
71
+ ## Status
72
+
73
+ Version 0.1 is deliberately read-only. It authenticates over HTTPS and reads
74
+ device identity, device-specific state, A/V I/O status, receive streams, and
75
+ transmit streams. An allow-listed read method also supports safe exploration
76
+ of documented objects such as Preview.
77
+
78
+ No reboot, routing, input, mode, stream, or configuration write can be issued
79
+ by this release.
80
+
81
+ The declared initial support scope is:
82
+
83
+ | Model | Firmware 6.0 | Firmware 7.1 |
84
+ | --- | --- | --- |
85
+ | DM-NVX-350 | Supported; validation pending | Supported; hardware validated |
86
+ | DM-NVX-360 | Supported; validation pending | Supported; hardware validated |
87
+ | DM-NVX-E30 | Supported; hardware validated | Supported; validation pending |
88
+
89
+ The parser detects capabilities from returned objects and fields. It does not
90
+ reject other firmware versions, but versions outside this table are currently
91
+ best-effort.
92
+
93
+ ## Installation
94
+
95
+ The package will be installable after its first PyPI release:
96
+
97
+ ```console
98
+ python -m pip install crestron-nvx
99
+ ```
100
+
101
+ For development before that release:
102
+
103
+ ```console
104
+ python -m pip install --editable '.[test]'
105
+ ```
106
+
107
+ ## Usage
108
+
109
+ ```python
110
+ from aiohttp import ClientSession
111
+ from crestron_nvx import NvxClient
112
+
113
+ async with ClientSession() as session:
114
+ client = NvxClient(
115
+ session,
116
+ "192.0.2.10",
117
+ "username",
118
+ "password",
119
+ verify_ssl=False,
120
+ )
121
+ snapshot = await client.async_get_snapshot()
122
+ print(snapshot.device.model)
123
+ ```
124
+
125
+ `verify_ssl=False` accepts an endpoint without authenticating its certificate.
126
+ This is often necessary for factory/self-signed DM NVX certificates, but an
127
+ on-path device could then impersonate the endpoint and receive its credentials.
128
+ Use that mode only on a trusted, isolated local network. Prefer
129
+ `verify_ssl=True` whenever the endpoint certificate is trusted by the client
130
+ host. Never log credentials, authentication cookies, raw device responses, or
131
+ personally identifying endpoint data.
132
+
133
+ ## Development
134
+
135
+ Install the test dependencies and run:
136
+
137
+ ```console
138
+ ruff format --check .
139
+ ruff check .
140
+ mypy
141
+ pytest --cov=crestron_nvx --cov-report=term-missing
142
+ python -m build
143
+ twine check dist/*
144
+ ```
145
+
146
+ Tests use small, invented fixtures that describe only the fields required to
147
+ exercise library behaviour. Raw device responses must not be committed.
148
+
149
+ ## Licence
150
+
151
+ Copyright © 2026 Daniel Wilson ([@Danw33](https://github.com/Danw33))
152
+
153
+ Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
154
+ The licence covers this project's code and documentation; it does not grant rights to third-party
155
+ trademarks, firmware, documentation, or other materials.
156
+
157
+ Crestron and DM NVX are trademarks of their respective owners.
@@ -0,0 +1,120 @@
1
+ # crestron-nvx
2
+
3
+ [![CI](https://github.com/Danw33/py-crestron-nvx/actions/workflows/ci.yml/badge.svg)](https://github.com/Danw33/py-crestron-nvx/actions/workflows/ci.yml)
4
+ [![Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
5
+
6
+ An **unofficial** async Python client for direct local communication with
7
+ Crestron DM NVX AV-over-IP endpoints.
8
+
9
+ > [!IMPORTANT]
10
+ > This is an independent, unofficial community project. It is not affiliated
11
+ > with, endorsed by, sponsored by, or supported by Crestron Electronics, Inc.
12
+ > Crestron, DigitalMedia, DM, DM NVX, and related names and marks are trademarks
13
+ > or registered trademarks of Crestron Electronics, Inc. in the United States
14
+ > and/or other countries. Their use here identifies compatible products only.
15
+ > Do not contact Crestron support for help with this library.
16
+
17
+ ## API provenance
18
+
19
+ This library implements Crestron's ** publicly documented DM NVX REST API**.
20
+ The authoritative external references are Crestron's public:
21
+
22
+ - [DM NVX REST API reference](https://sdkcon78221.crestron.com/sdk/DM_NVX_REST_API/Content/Topics/API-Reference.htm)
23
+ - [DM NVX API authentication guide](https://sdkcon78221.crestron.com/sdk/DM_NVX_REST_API/Content/Topics/Authentication.htm)
24
+
25
+ Those references describe the API's HTTPS authentication, GET/POST methods,
26
+ object paths, property types, and model-specific applicability. This repository
27
+ does not copy or redistribute Crestron manuals, schemas, examples, firmware, or
28
+ other proprietary material. The external documentation and device behaviour
29
+ may change, and continued compatibility is not guaranteed.
30
+
31
+ See [API_PROVENANCE.md](docs/API_PROVENANCE.md) for the project's source and
32
+ fixture policy.
33
+
34
+ ## Status
35
+
36
+ Version 0.1 is deliberately read-only. It authenticates over HTTPS and reads
37
+ device identity, device-specific state, A/V I/O status, receive streams, and
38
+ transmit streams. An allow-listed read method also supports safe exploration
39
+ of documented objects such as Preview.
40
+
41
+ No reboot, routing, input, mode, stream, or configuration write can be issued
42
+ by this release.
43
+
44
+ The declared initial support scope is:
45
+
46
+ | Model | Firmware 6.0 | Firmware 7.1 |
47
+ | --- | --- | --- |
48
+ | DM-NVX-350 | Supported; validation pending | Supported; hardware validated |
49
+ | DM-NVX-360 | Supported; validation pending | Supported; hardware validated |
50
+ | DM-NVX-E30 | Supported; hardware validated | Supported; validation pending |
51
+
52
+ The parser detects capabilities from returned objects and fields. It does not
53
+ reject other firmware versions, but versions outside this table are currently
54
+ best-effort.
55
+
56
+ ## Installation
57
+
58
+ The package will be installable after its first PyPI release:
59
+
60
+ ```console
61
+ python -m pip install crestron-nvx
62
+ ```
63
+
64
+ For development before that release:
65
+
66
+ ```console
67
+ python -m pip install --editable '.[test]'
68
+ ```
69
+
70
+ ## Usage
71
+
72
+ ```python
73
+ from aiohttp import ClientSession
74
+ from crestron_nvx import NvxClient
75
+
76
+ async with ClientSession() as session:
77
+ client = NvxClient(
78
+ session,
79
+ "192.0.2.10",
80
+ "username",
81
+ "password",
82
+ verify_ssl=False,
83
+ )
84
+ snapshot = await client.async_get_snapshot()
85
+ print(snapshot.device.model)
86
+ ```
87
+
88
+ `verify_ssl=False` accepts an endpoint without authenticating its certificate.
89
+ This is often necessary for factory/self-signed DM NVX certificates, but an
90
+ on-path device could then impersonate the endpoint and receive its credentials.
91
+ Use that mode only on a trusted, isolated local network. Prefer
92
+ `verify_ssl=True` whenever the endpoint certificate is trusted by the client
93
+ host. Never log credentials, authentication cookies, raw device responses, or
94
+ personally identifying endpoint data.
95
+
96
+ ## Development
97
+
98
+ Install the test dependencies and run:
99
+
100
+ ```console
101
+ ruff format --check .
102
+ ruff check .
103
+ mypy
104
+ pytest --cov=crestron_nvx --cov-report=term-missing
105
+ python -m build
106
+ twine check dist/*
107
+ ```
108
+
109
+ Tests use small, invented fixtures that describe only the fields required to
110
+ exercise library behaviour. Raw device responses must not be committed.
111
+
112
+ ## Licence
113
+
114
+ Copyright © 2026 Daniel Wilson ([@Danw33](https://github.com/Danw33))
115
+
116
+ Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
117
+ The licence covers this project's code and documentation; it does not grant rights to third-party
118
+ trademarks, firmware, documentation, or other materials.
119
+
120
+ Crestron and DM NVX are trademarks of their respective owners.
@@ -0,0 +1,17 @@
1
+ # Security policy
2
+
3
+ ## Supported versions
4
+
5
+ Until the first public release, only the current `main` branch receives
6
+ security fixes. After release, the latest published minor version will be
7
+ supported.
8
+
9
+ ## Reporting a vulnerability
10
+
11
+ Please use GitHub's private vulnerability reporting for this repository. Do
12
+ not include real device credentials, cookies, addresses, serial numbers, raw
13
+ responses, or network captures unless a maintainer explicitly requests a
14
+ secure transfer method.
15
+
16
+ Ordinary compatibility bugs that contain no sensitive information may be
17
+ reported through the public issue tracker.
@@ -0,0 +1,27 @@
1
+ # API provenance and clean-source policy
2
+
3
+ This project is an independent implementation of Crestron's publicly
4
+ accessible, publicly documented DM NVX REST API:
5
+
6
+ - [API reference](https://sdkcon78221.crestron.com/sdk/DM_NVX_REST_API/Content/Topics/API-Reference.htm)
7
+ - [Authentication](https://sdkcon78221.crestron.com/sdk/DM_NVX_REST_API/Content/Topics/Authentication.htm)
8
+
9
+ The public reference identifies the HTTPS session procedure, API object paths,
10
+ methods, property names, property types, and model-specific applicability. The
11
+ implementation is based on those public descriptions plus ordinary
12
+ compatibility testing of documented API responses from hardware owned or
13
+ administered by contributors.
14
+
15
+ This repository must not contain copied vendor prose, documentation pages,
16
+ sample payloads, diagrams, firmware, decompiled code, credentials, cookies,
17
+ private SDK material, or information supplied under confidentiality terms.
18
+ Contributors must not submit material they are not entitled to share.
19
+
20
+ Tests use minimal synthetic payloads with invented identifiers and addresses.
21
+ Hardware observations may establish whether documented fields are present,
22
+ absent, or represented by a documented primitive type; raw responses and
23
+ network captures must remain outside the repository.
24
+
25
+ Public documentation does not imply that Crestron endorses this project,
26
+ guarantees the API, or promises compatibility across releases. The upstream
27
+ documentation remains authoritative and should be linked rather than copied.
@@ -0,0 +1,82 @@
1
+ [build-system]
2
+ requires = ["setuptools>=77"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "crestron-nvx"
7
+ version = "0.1.0"
8
+ description = "Unofficial async Python client for Crestron DM NVX devices"
9
+ readme = "README.md"
10
+ requires-python = ">=3.11"
11
+ license = "Apache-2.0"
12
+ license-files = ["LICENSE", "NOTICE"]
13
+ authors = [{name = "Dan Wilson"}]
14
+ keywords = ["crestron", "dm-nvx", "av-over-ip", "asyncio"]
15
+ classifiers = [
16
+ "Development Status :: 3 - Alpha",
17
+ "Framework :: AsyncIO",
18
+ "Intended Audience :: Developers",
19
+ "Operating System :: OS Independent",
20
+ "Programming Language :: Python :: 3",
21
+ "Programming Language :: Python :: 3 :: Only",
22
+ "Programming Language :: Python :: 3.11",
23
+ "Programming Language :: Python :: 3.12",
24
+ "Programming Language :: Python :: 3.13",
25
+ "Programming Language :: Python :: 3.14",
26
+ "Typing :: Typed",
27
+ ]
28
+ dependencies = [
29
+ "aiohttp>=3.9.0",
30
+ "yarl>=1.9.4",
31
+ ]
32
+
33
+ [project.optional-dependencies]
34
+ test = [
35
+ "build>=1.2.2",
36
+ "mypy>=1.15.0",
37
+ "pytest>=8.3.0",
38
+ "pytest-asyncio>=0.25.0",
39
+ "pytest-cov>=6.0.0",
40
+ "ruff>=0.9.0",
41
+ "twine>=6.1.0",
42
+ ]
43
+
44
+ [project.urls]
45
+ Documentation = "https://github.com/Danw33/py-crestron-nvx#readme"
46
+ Issues = "https://github.com/Danw33/py-crestron-nvx/issues"
47
+ Source = "https://github.com/Danw33/py-crestron-nvx"
48
+
49
+ [tool.setuptools.packages.find]
50
+ where = ["src"]
51
+
52
+ [tool.setuptools.package-data]
53
+ crestron_nvx = ["py.typed"]
54
+
55
+ [tool.pytest.ini_options]
56
+ asyncio_mode = "auto"
57
+ testpaths = ["tests"]
58
+ pythonpath = ["src"]
59
+ addopts = "--strict-markers --strict-config"
60
+
61
+ [tool.coverage.run]
62
+ branch = true
63
+ source = ["crestron_nvx"]
64
+
65
+ [tool.coverage.report]
66
+ fail_under = 95
67
+ show_missing = true
68
+ skip_covered = true
69
+
70
+ [tool.ruff]
71
+ target-version = "py311"
72
+ line-length = 88
73
+
74
+ [tool.ruff.lint]
75
+ select = ["B", "C4", "E4", "E7", "E9", "F", "I", "PIE", "RUF", "SIM", "UP"]
76
+
77
+ [tool.mypy]
78
+ python_version = "3.11"
79
+ strict = true
80
+ warn_unreachable = true
81
+ show_error_codes = true
82
+ files = ["src/crestron_nvx"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+