Skip to content

Commit

Permalink
Merge pull request #2782 from florianm/patch-1
Browse files Browse the repository at this point in the history
Pin third party requs in requirements.txt, not setup.py
  • Loading branch information
David Read committed Dec 10, 2015
2 parents c803efd + 69e6ce3 commit c83e2ee
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions doc/extensions/best-practices.rst
Expand Up @@ -56,3 +56,23 @@ Internationalize user-visible strings

All user-visible strings should be internationalized, see
:doc:`/contributing/string-i18n`.


---------------------------------------------
Add third party libraries to requirements.txt
---------------------------------------------

If your extension requires third party libraries, rather than
adding them to ``setup.py``, they should be added
to ``requirements.txt``, which can be installed with::

pip install -r requirements.txt
To prevent accidental breakage of your extension through backwards-incompatible
behaviour of newer versions of your dependencies, their versions should be pinned,
such as::

requests==2.7.0
On the flip side, be mindful that this could also create version conflicts with
requirements of considerably newer or older extensions.

0 comments on commit c83e2ee

Please sign in to comment.