Write tutorial to deploy simple Django app on Heroku #365

zkan · 2017-10-07T14:40:15Z

Changes proposed in this pull request:

Write a tutorial to deploy a simple Hello Email Django app on Heroku.

Connected to #356.

SendGridDX · 2017-10-07T14:40:31Z

All committers have signed the CLA.

zkan · 2017-10-17T23:50:25Z

@thinkingserious Could you please review this PR? I'd love to see some feedback. :)

mbernier · 2017-10-22T17:37:06Z

USE_CASES.md

+Now we should be able to send an email. Let's run our Django development server to test it. Find the file `manage.py` then run:
+
+```
+$ python manage.py runserver


Should we tell them to:
cd hello_sendgrid
?

Also, when I ran this, I got this error:

You have 13 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, contenttypes, sessions. Run 'python manage.py migrate' to apply them.

I ran python manage.py migrate and then the server started running properly

mbernier · 2017-10-22T17:37:36Z

USE_CASES.md

+        apikey=os.environ.get('SENDGRID_API_KEY')
+    )
+    from_email = Email('[email protected]')
+    to_email = Email('[email protected]')


Should we suggest they put their own email in the to_email variable, so that they can see the email they receive?

I've added a note below this code already.

mbernier

I have some suggestions as well as a problem deploying to heroku. I really appreciate your help!

mbernier · 2017-10-22T17:39:07Z

USE_CASES.md

+Now we should be able to send an email. Let's run our Django development server to test it. Find the file `manage.py` then run:
+
+```
+$ python manage.py runserver


Also, when I ran this, I got this error:

You have 13 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, contenttypes, sessions. Run 'python manage.py migrate' to apply them.

I ran python manage.py migrate and then the server started running properly

mbernier · 2017-10-22T17:44:04Z

USE_CASES.md

+$ python manage.py runserver
+```
+
+By default, it starts the development server at `http://127.0.0.1:8000/`. To test if we can send email or not, go to `http://127.0.0.1:8000/sendgrid/`. If it works, we should see the page says "Email Sent!".


Can you please add something to the effect:

Note: If you use [email protected] as your from email, it's likely to go to your spam folder. To have the emails show up in your inbox, try using an email address at the domain you registered your SendGrid account.

mbernier · 2017-10-22T17:45:33Z

USE_CASES.md

+from .views import index
+
+
+urlpatterns = [


Since this is a test app, how do you feel about using the following URL patterns to make things a bit easier?

urlpatterns = [ url(r'^admin/', admin.site.urls), url(r'^$', index, name='sendgrid'), url(r'', index, name='sendgrid'), ]

Then we can add a note to say "These paths allow the root URL to send the email, for a true django app, you may want to move this script to another url, like so:

urlpatterns = [ url(r'^admin/', admin.site.urls), url(r'^sendgrid/', index, name='sendgrid'), ]

I've revised my text and kept only one url like this:

urlpatterns = [ url(r'^admin/', admin.site.urls), url(r'^$', index, name='sendgrid'), ]

I think having one URL for index should be enough. What do you think?

mbernier · 2017-10-22T17:48:14Z

USE_CASES.md

@@ -171,6 +172,186 @@ print(response.body)
 print(response.headers)
 ```

+<a name="hello_email_django_on_heroku"></a>
+# Deploy a Simple Hello Email Django App on Heroku


Can you change this to "Create a Django app to send email with SendGrid"

-- This way, it's a top level section about Django and we can add other deployment methods as H2s below.

mbernier · 2017-10-22T17:50:12Z

USE_CASES.md

@@ -4,6 +4,7 @@ This documentation provides examples for specific use cases. Please [open an iss

 * [Transactional Templates](#transactional_templates)
 * [Attachment](#attachment)
+* [Deploy a Simple Hello Email Django App on Heroku](#hello_email_django_on_heroku)


Can you please add:

* [Create a Django app to send email with SendGrid](#create-a-django-app-to-send-email-with-sendgrid) * [Deploy to Heroku](#deploy-to-heroku)

mbernier · 2017-10-22T17:52:26Z

USE_CASES.md

+
+We also need to do a couple things:
+
+1. Add `'*'` or your Heroku app domain to `ALLOWED_HOSTS` in the file `settings.py`.


Will look like

ALLOWED_HOSTS = ['*']

mbernier · 2017-10-22T17:58:37Z

USE_CASES.md

+
+## Deploy to Heroku
+
+Before we start the deployment, let's log in to your Heroku account and create a Heroku app. This tutorial uses `hello-sendgrid`.


Instead of logging in to create the app, can we suggest taht just after git init below, that the user do this:

heroku create hello-sendgrid

Note: if they see heroku reply with "this already exists" suggest adding a random string to the end of the name. They will need to update this line with the new name:
heroku git:remote -a hello-sendgrid

mbernier · 2017-10-22T18:12:02Z

USE_CASES.md

+```
+$ git add .
+$ git commit -am "Create simple Hello Email Django app using SendGrid"
+$ git push heroku master


I got to here and then got this error, I tried creating a runtime.txt file and that didn't change anything.

remote: Compressing source files... done. remote: Building source: remote: remote: ! No default language could be detected for this app. remote: HINT: This occurs when Heroku cannot detect the buildpack to use for this application automatically. remote: See https://devcenter.heroku.com/articles/buildpacks remote: remote: ! Push failed remote: Verifying deploy... remote: remote: ! Push rejected to hello-sendgrid-django-python. remote: To https://git.heroku.com/hello-sendgrid-django-python.git ! [remote rejected] master -> master (pre-receive hook declined) error: failed to push some refs to 'https://git.heroku.com/hello-sendgrid-django-python.git'

I found a bug in my tutorial. Previously, I said:

$ pip freeze > requirements.text

The issue was Heroku couldn't detect requirements.text. It actually should be requirements.txt. I have fixed that already.

mbernier · 2017-10-22T18:12:27Z

USE_CASES.md

+$ git push heroku master
+```
+
+We have not finished yet. We need to go to the Heroku settings and add your `SENDGRID_API_KEY` as one of the Heroku environment variables in the Config Variables section.


I believe this can be done over the CLI like this: https://devcenter.heroku.com/articles/config-vars#setting-up-config-vars-for-a-deployed-application

mbernier · 2017-10-22T18:12:53Z

USE_CASES.md

+
+We have not finished yet. We need to go to the Heroku settings and add your `SENDGRID_API_KEY` as one of the Heroku environment variables in the Config Variables section.
+
+After that, let's verify if our app is working or not by accessing the Heroku app domain and going to `/sendgrid/`. You should see the page says "Email Sent!" and on the Activity Feed page in the SendGrid dashboard, you should see a new feed with the email `[email protected]`.


If we use the routing I added above, they can go to the root of the heroku app

codecov-io · 2017-10-24T02:55:13Z

Codecov Report

Merging #365 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master   #365   +/-   ##
=====================================
  Coverage      83%    83%           
=====================================
  Files          30     30           
  Lines        1024   1024           
  Branches      160    160           
=====================================
  Hits          850    850           
  Misses         84     84           
  Partials       90     90

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3ec799f...50ea2f4. Read the comment docs.

zkan · 2017-10-24T02:55:42Z

@mbernier Thank you very much for your feedback. I've revised my tutorial already.

mbernier · 2017-11-03T15:43:51Z

@zkan

We have not been able to merge your Pull Request, but because you are awesome - we wanted to make sure you could still get a SendGrid Hacktoberfest shirt.

Please go fill out our swag form before Nov 5th and we will send the shirt! (We know that you might have tried this before and it didn’t work, sorry about that!)

You have till Nov 5th to fill out this form in order to get the Hacktoberfest shirt!

Thank you for contributing during Hacktoberfest! We hope to see you in the repos soon! Just so you know, we always give away a SendGrid shirt for your first ever non-Hacktoberfest PR that gets merged.

zkan · 2017-11-04T02:37:22Z

@mbernier Thank you! I've just filled out the form.

I'm also very happy to continue working on this PR until it gets merged. :)

thinkingserious · 2017-11-04T17:48:21Z

Thanks @zkan!

thinkingserious · 2017-11-30T04:38:13Z

USE_CASES.md

+
+urlpatterns = [
+    url(r'^admin/', admin.site.urls),
+    url(r'^$', index, name='sendgrid'),


With this code, I get an error when trying to go to http://127.0.0.1:8000/sendgrid/: https://screencast.com/t/NrcQ2pHAtWi

But if I use url(r'^sendgrid/', index, name='sendgrid') it works fine.

@thinkingserious Thank you for the review! I've revised the text and removed the part I think it may confuse readers.

- Remove the root URL setup part that may confuse readers - Revise the text

thinkingserious · 2017-12-01T18:05:46Z

Hello @zkan,

Thanks again for the PR!

We appreciate your contribution and look forward to continued collaboration. Thanks!

Team SendGrid DX

zkan · 2017-12-03T00:10:29Z

@thinkingserious @mbernier Thank you!

Add tutorial to deploy simple Django app on Heroku

9018ced

thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 7, 2017

Fix conflict with asyncio

8e79259

mbernier reviewed Oct 22, 2017

View reviewed changes

mbernier suggested changes Oct 22, 2017

View reviewed changes

mbernier added difficulty: hard fix is hard in difficulty hacktoberfest labels Oct 22, 2017

zkan added 2 commits October 24, 2017 09:43

Revise tutorial according to review

9b8c86c

Merge with Setting up domain whitelabel and viewing email stats

3d6bd6a

Merge error handling

c97e772

apigirl added hacktoberfest and removed hacktoberfest labels Oct 31, 2017

thinkingserious requested changes Nov 30, 2017

View reviewed changes

Use only URL /sendgrid/ to send email

50ea2f4

- Remove the root URL setup part that may confuse readers - Revise the text

thinkingserious approved these changes Dec 1, 2017

View reviewed changes

thinkingserious merged commit 04fb74f into sendgrid:master Dec 1, 2017

zkan deleted the write_tutorial_to_deploy_django_to_heroku branch December 3, 2017 00:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Write tutorial to deploy simple Django app on Heroku #365

Write tutorial to deploy simple Django app on Heroku #365

zkan commented Oct 7, 2017

SendGridDX commented Oct 7, 2017 •

edited

Loading

zkan commented Oct 17, 2017

mbernier Oct 22, 2017

mbernier Oct 22, 2017

mbernier Oct 22, 2017

zkan Oct 24, 2017

mbernier left a comment

mbernier Oct 22, 2017

mbernier Oct 22, 2017

mbernier Oct 22, 2017

zkan Oct 24, 2017

mbernier Oct 22, 2017

mbernier Oct 22, 2017

mbernier Oct 22, 2017

mbernier Oct 22, 2017

mbernier Oct 22, 2017

zkan Oct 24, 2017

mbernier Oct 22, 2017

mbernier Oct 22, 2017

codecov-io commented Oct 24, 2017 •

edited by codecov bot

Loading

zkan commented Oct 24, 2017

mbernier commented Nov 3, 2017

zkan commented Nov 4, 2017 •

edited

Loading

thinkingserious commented Nov 4, 2017

thinkingserious Nov 30, 2017

zkan Dec 1, 2017

thinkingserious commented Dec 1, 2017

zkan commented Dec 3, 2017


		We also need to do a couple things:

		1. Add `'*'` or your Heroku app domain to `ALLOWED_HOSTS` in the file `settings.py`.


		## Deploy to Heroku

		Before we start the deployment, let's log in to your Heroku account and create a Heroku app. This tutorial uses `hello-sendgrid`.


		We have not finished yet. We need to go to the Heroku settings and add your `SENDGRID_API_KEY` as one of the Heroku environment variables in the Config Variables section.

		After that, let's verify if our app is working or not by accessing the Heroku app domain and going to `/sendgrid/`. You should see the page says "Email Sent!" and on the Activity Feed page in the SendGrid dashboard, you should see a new feed with the email `[email protected]`.

Write tutorial to deploy simple Django app on Heroku #365

Write tutorial to deploy simple Django app on Heroku #365

Conversation

zkan commented Oct 7, 2017

SendGridDX commented Oct 7, 2017 • edited Loading

zkan commented Oct 17, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mbernier left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Oct 24, 2017 • edited by codecov bot Loading

Codecov Report

zkan commented Oct 24, 2017

mbernier commented Nov 3, 2017

You have till Nov 5th to fill out this form in order to get the Hacktoberfest shirt!

zkan commented Nov 4, 2017 • edited Loading

thinkingserious commented Nov 4, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thinkingserious commented Dec 1, 2017

zkan commented Dec 3, 2017

SendGridDX commented Oct 7, 2017 •

edited

Loading

codecov-io commented Oct 24, 2017 •

edited by codecov bot

Loading

zkan commented Nov 4, 2017 •

edited

Loading