Reference calitp-data-infra package as additional context in Python libraries doc #2856
Conversation
SorenSpicknall
requested review from
charlie-costanzo and
lauriemerrell
as code owners
| 5. [Add New Packages](#add-new-packages) | ||
| <br> - [calitp-data-infra](#calitp-data-infra) |
There was a problem hiding this comment.
Should calitp-data-infra live in an appendix? the table of contents looks weird
There was a problem hiding this comment.
I grouped it under Add New Packages because the docs refer to the other packages as built into the JupyterHub environment, and I thought it would be useful to have the final section list other useful (but not automatically available) packages as subheadings. However, maybe I'm overemphasizing the bit of the docs about how the other packages come preinstalled on JupyterHub, and should just treat cal-itp-data-infra as another top-level heading? Happy to do what you feel makes the most sense.
There was a problem hiding this comment.
Yeah, I would suggest moving calitp-data-infra into an appendix. It really should be separate and unnecessary to install in the image for the most part.
Description
This PR adds a small subsection under the existing "Add New Packages" heading in the analyst-facing Useful Python Libraries guide, outlining the existence of the
calitp-data-infrapackage and referencing the fact that it's used for some advanced tasks like authenticating sync pipelines. This is not meant to be comprehensive in any way, but provides an entry point to conceptual familiarity withcalitp-data-infraand with our secrets handling in an easily approachable place.Additionally, this PR makes some linting fixes to the existing markdown document that was edited.
Type of change
How has this been tested?
Markdown linted sucessfully
Post-merge follow-ups