Skip to content

Commit

Permalink
Merge pull request #3 from fjsj/patch-1
Browse files Browse the repository at this point in the history
Closes #2: add note about Heroku deployment on doc
  • Loading branch information
carljm committed May 23, 2016
2 parents 5806d35 + 509b608 commit 721856e
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,24 @@ 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 721856e

Please sign in to comment.