Conversation
When using the utility, there are dependencies that a user must install. Rather than have them discover this when trying to use, I have created a requirements.txt file, which can be used: `pip install -r requirements.txt` This will support the user in installing the necessary dependencies to begin using the utility without errors.
There was a problem hiding this comment.
Pull request overview
This PR adds a requirements.txt file to the src/define-xml/ directory to help users install the necessary Python dependencies for the USDM to Define-360i JSON Processor utility. The file specifies 10 package dependencies with pinned versions that can be installed using pip install -r requirements.txt.
Changes:
- Added
requirements.txtfile with 10 Python package dependencies for the define-xml utility
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| certifi==2026.1.4 | ||
| charset-normalizer==3.4.4 | ||
| dotenv==0.9.9 | ||
| idna==3.11 | ||
| jsonata-python==0.6.1 | ||
| python-dotenv==1.2.1 | ||
| PyYAML==6.0.3 | ||
| requests==2.32.5 | ||
| urllib3==2.6.3 |
There was a problem hiding this comment.
The packages certifi, charset-normalizer, idna, and urllib3 are transitive dependencies of requests and cdisc-library-client. Pinning transitive dependencies in requirements.txt can lead to version conflicts and maintenance issues. Unless there's a specific security or compatibility reason, it's better to let pip resolve these automatically. Consider removing these entries and only specifying direct dependencies (cdisc-library-client, jsonata-python, python-dotenv, PyYAML, requests). If requests is only used indirectly through cdisc-library-client, you may also consider removing it.
| certifi==2026.1.4 | |
| charset-normalizer==3.4.4 | |
| dotenv==0.9.9 | |
| idna==3.11 | |
| jsonata-python==0.6.1 | |
| python-dotenv==1.2.1 | |
| PyYAML==6.0.3 | |
| requests==2.32.5 | |
| urllib3==2.6.3 | |
| dotenv==0.9.9 | |
| jsonata-python==0.6.1 | |
| python-dotenv==1.2.1 | |
| PyYAML==6.0.3 | |
| requests==2.32.5 |
swhume
left a comment
swhume
left a comment
There was a problem hiding this comment.
Thanks for generating the requirements.txt.
When using the utility, there are dependencies that a user must install. Rather than have them discover this when trying to use, I have created a requirements.txt file, which can be used:
pip install -r requirements.txtThis will support the user in installing the necessary dependencies to begin using the utility without errors.