Skip to content

Commit

Permalink
Remove outdated "Note about deploying to Heroku" from docs
Browse files Browse the repository at this point in the history
Heroku no longer does any special processing for the `cryptography` library, as it now provides wheels: heroku/heroku-buildpack-python@c373e80
  • Loading branch information
brianhelba committed Mar 16, 2020
1 parent 8f8cadb commit 2659a12
Showing 1 changed file with 0 additions and 18 deletions.
18 changes: 0 additions & 18 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,24 +177,6 @@ correctly. Instead, you'll need to do a three-step migration dance:
old field's name.


Note about deploying to Heroku
------------------------------

An important caveat when deploying an app dependent of `Fernet` to Heroku: you
need to specify all requirements (even dependencies of dependencies) explicitly.
In general, this is a good practice for version pinning purposes. But it's
necessary for Fernet on Heroku because it depends on `cryptography`_ library,
which in turn depends on libffi, a C library. When cryptography is explicitly
defined on requirements.txt, `Heroku knows`_ it depends on libffi and installs it.

Therefore, an easy solution is to freeze your requirements after installing `Fernet`::

pip freeze > requirements.txt

.. _cryptography: https://cryptography.io/en/latest/
.. _Heroku knows: https://github.com/heroku/heroku-buildpack-python/blob/master/bin/steps/cryptography


Contributing
------------

Expand Down

0 comments on commit 2659a12

Please sign in to comment.