Rename requirements.txt in this repo to prevent confusion from users vs package devs #434

Activity

1. ned2 commented on Oct 27, 2018

   

   ned2

   on Oct 27, 2018 via email

   Contributor

   More actions

   I see dev_requirements.txt used a bit for this purpose. But putting it in a folder I think would be the safest option. Contributors will be reading the contributing instructions anyway before they start, so discovery is not an issue for them.

   …

   On Thu, Oct 25, 2018, 07:27 Chris Parmer ***@***.***> wrote: Several users have thought that installing therequirements.txt in this project is the correct way to install the necsesary dependencies for dash (rather than visiting dash.plot.ly/installation). See #433 (comment) <#433 (comment)> and some of the issues in https://github.com/plotly/dash/issues?utf8=%E2%9C%93&q=is%3Aissue+requirements.txt . Is there any way that we can help prevent these issues? Thoughts: - Rename requirements.txt to something like contributing_requirements.txt or place it in a folder like contributing/requirements.txt - Perhaps we can add a "Quickstart" link at the very top of the README.md with a link to https://dash.plot.ly/installation — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#434>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACs1GPSxhb4F7jyNDpRTrSU16x7-lecuks5uoM1OgaJpZM4X44Yp> .
2. T4rk1n commented on Oct 29, 2018

   

   T4rk1n

   on Oct 29, 2018

   Contributor

   More actions

   We don't even use the requirements.txt, was made with pip freeze, the versions are locked and probably out of date. pip freeze never makes good requirements files IMO, it includes dependencies of dependencies so it includes a bunch of packages that should be managed by their dependents instead. We use the dev-requirements.txt and dev-requirements-37.txt. So I guess we could delete it and move the other two in a folder like .circleci/requirements/....

   👍React with 👍1Reacted by Chris Parmer
3. chriddyp commented on Oct 29, 2018

   

   chriddyp

   on Oct 29, 2018

   MemberAuthor

   More actions

   Cool, that sounds good @T4rk1n
4. T4rk1n

   self-assigned this

   on Oct 29, 2018
5. T4rk1n

   closed this as completedin #439on Oct 30, 2018