search

cfpb / development

A repository for the discussion and publication of the CFPB development team standards.
Creative Commons Zero v1.0 Universal
64 stars 32 forks source link

Add section about python dependencies #172

Closed willbarton closed 6 years ago

willbarton commented 6 years ago

This PR adds a section to our Python standards about dependency specification in requirements.txt and setup.py files.

The motivation for this is two-fold; first, the perpetual confusion around this in the Python world and the subsequent confusion this causes folks who just want to get their work done, and second discovering that we have some disparity in regard to this, along with some places where folks have tried to bridge the gap between requirements.txt and setup.py.

Hopefully this is succinctly helpful as it is, and it includes a link to a more in-depth discussion. Donald Stufft's article is linked to by the pip documentation for this same reason.

I've made no mention of pipenv here, as we don't really use it yet for anything (or related tools).

acrewdson commented 6 years ago

Another good post that addresses some of these issues: https://www.b-list.org/weblog/2018/apr/25/lets-talk-about-packages/

higs4281 commented 6 years ago

Thanks, @willbarton for clarifying requirements, and for the link, @acrewdson So pypi was originally the cheese shop, and thus wheels. the flying circus runs deep.

willbarton commented 6 years ago

Any objections to merging?