Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove outdated "Note about deploying to Heroku" from docs #23

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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