This recipe assumes that you have a TurboGears app setup using a Paste INI file, inside a package called ‘myapp’. If you are deploying a custom TurboGears application in minimal mode you might have to tune the following instructions.
Install the heroku gem per their instructions.
You will need to add the following files with the contents as shown to the root of your project directory (the directory containing the setup.py).
requirements.txt:
You can autogenerate this file by running:
$ pip freeze > requirements.txt
You will have probably have a line in your requirements file that has your project name in it. It might look like either of the following two lines depending on how you setup your project. If either of these lines exist, delete them.
projectname=0.1dev
or
-e git+git@xxxx:<git username>/xxxxx.git....#egg=projectname
Now that you have properly frozen your application dependencies it is required to add the webserver you want to use to actually serve your application requests.
This tutorial uses the Waitress webserver, so we need to add it to the dependencies
declared in the requirements.txt
$ echo "waitress" >> requirements.txt
As heroku passes some configuration options in ENVIRON variables, it is necessary
for our application to read them from the Heroku environment. Those are typically
the PORT where your application server has to listen, the URL of your
database and so on…
First of all we need to copy the development.ini to a production.ini file
we are going to use for the heroku deployment:
$ cp development.ini production.ini
The only options you are required to change are the one related to the server.
So your [server:main] section should look like:
[server:main]
use = egg:waitress#main
host = 0.0.0.0
get port = heroku_port
Then probably want to disable the debug inside the [DEFAULT] section.
Note
If you want to use a different server instead of waitress, as gevent,
CherryPy or something else, as far as it is compatible with PasteDeploy
changing the use = egg:waitress#main to whatever you want usually is enough.
In case you want to use gevent, for you can change it to use = egg:gearbox#gevent.
Procfile:
Generate this by running:
$ echo "web: ./run" > Procfile
run:
Create run with the following:
#!/bin/bash
python setup.py develop
gearbox serve --debug -c production.ini heroku_port=$PORT
Note
Make sure to chmod +x run before continuing.
The ‘develop’ step is necessary because the current package must be
installed before paste can load it from the INI file.
Navigate to your project directory (directory with setup.py) if not already there. If you project is already under git version control, skip to the ‘Initialize the heroku stack’ section.
Inside your projects directory, if this project is not tracked under git it is recommended that you first create a good .gitignore file (you can skip this step). You can get the recommended python one by running:
$ wget -O .gitignore https://raw.github.com/github/gitignore/master/TurboGears2.gitignore
Once that is done, run:
$ git init
$ git add .
$ git commit -m "initial commit"
$ heroku create
To deploy a new version, push it to heroku:
$ git push heroku master
Make sure to start one worker:
$ heroku scale web=1
Check to see if your app is running
$ heroku ps
Take a look at the logs to debug any errors if necessary:
$ heroku logs -t