Django example updates #152

Cawllec · 2018-05-09T16:33:25Z

From this PR by @tremlab, this addition changes the Django tests to no longer rely on the Django example, but on a django app in the test/fixtures folder, which was stopping the previous PR from being mergeable.

I realise the linter is failing this at the moment, so will be investigating why ASAP.

…swith from md to html

…nto tremlab-django_ex

…to django_ex

…nto tremlab-django_ex

…s/django

…s/django - Update travis.yml

…s/django - Fix linter issues

fractalwrench · 2018-05-10T08:19:45Z

example/django/README.md

-Pressing this link would lead to an empty page, which is normal.
-See `demo/views.py, #crash`
+1. Before testing it, open up the [`settings.py`](bugsnag_demo/settings.py)
+    file and configure your API key.


I opened up this file and saw SECRET_KEY, which could potentially be a bit confusing (for PyNoobs). Could we define a similar constant for the API key at the top of the file also?

That's a Django feature. To avoid confusion I could modify to:

Before testing it, open up the [`settings.py`](bugsnag_demo/settings.py) file and configure your API key within the `BUGSNAG` dictionary.

fractalwrench · 2018-05-10T08:21:24Z

example/django/README.md

+    python manage.py runserver
+    ```

+1. View the example page which will (most likely) be served at: http://localhost:8000


What circumstances would cause it not to be served on 8000? Do we know what the port would be in that case?

The user can change the port when starting the server, although I agree on the language change, perhaps to which, by default, will be served at:

fractalwrench · 2018-05-10T08:22:05Z

example/django/README.md

-`info`.
-See `demo/views.py, #severity`
+For more information, see our documentation:
+https://docs.bugsnag.com/platforms/python/django/


Do we want to use a markdown link for this?

fractalwrench · 2018-05-10T08:24:16Z

example/django/README.md

-when notifying bugsnag of the error. Valid severities are `error`, `warning` and
-`info`.
-See `demo/views.py, #severity`
+For more information, see our documentation:


Might be worth adding an extra step here for unfamiliar users, stating that you can send errors and see them immediately show up on dashboard.

That's mentioned above at line 9, and also mentioned in the messages received from the server when calling the functionality. Would it be a good idea to link to app.bugsnag.com at the bottom of the README?

If it's mentioned in the server messages, then I don't think this requires any change

fractalwrench · 2018-05-10T08:25:57Z

example/django/bugsnag_demo/settings.py


 STATIC_URL = '/static/'

+# Initialize Bugsnag to begin tracking errors. Only an api key is required, but here are some other helpful configuration details:


This is very useful!

fractalwrench · 2018-05-10T08:26:19Z

example/django/bugsnag_demo/settings.py

+    # By default, requests are sent asynchronously. If you would like to block until the request is done, you can set to false.
    "asynchronous": False,
+
+    # if you track deploys or session rates, make sure to set the correct version.


fractalwrench · 2018-05-10T08:28:45Z

example/django/README.md

-```
+1. Clone the repo and `cd` into this directory:
+    ```shell
+    git clone https://github.com:bugsnag/bugsnag-python.git


This doesn't work (there's a colon instead of a forward slash)

fractalwrench · 2018-05-10T08:38:07Z

example/django/bugsnag_demo/urls.py

+    url(r'^crashcallback/$', crash_with_callback),
+    url(r'^handled/$', handled),
+    url(r'^notifywithcontext/$', context),
+    url(r'^notifywithmetadata/$', notify_meta),


The old example app seems to have a severity endpoint - is this concept demonstrated to users in one of the above URLs?

Not sure about this, I'll query it.

Yes, the context endpoint now modifies the severity.

fractalwrench · 2018-05-10T08:41:49Z

example/django/index.html

+          <button type="button">NOTIFICATION WITH METADATA</button>
+        </a>
+    </div>
+<!-- review settings.py & views.py to see how bugsnag integrates with your app. -->


If this message is necessary, it would be better as an element than a comment so it's visible when editing or viewing in the browser.

It isn't, it's just a comment for people browsing the html.

fractalwrench

Left a few minor comments inline. I really like the level of inline docs/pydoc in the examples. The one comment that definitely needs addressing is a typo in the setup instructions that means git clone doesn't work out-of-the-box.

- Minor wording fixes

Cawllec · 2018-05-10T14:15:38Z

I've changed the target to Master as this is primarily an examples update and should reflect on the main repository.

fractalwrench

This looks good to me assuming it has been tested by Alex/Renee. Approving with the provision that we should inform the relevant people at PyCon before merging this.

Cawllec · 2018-05-11T09:21:10Z

Sounds good. As soon as Renee is online I'll inform her and merge afterwards.

tremlab and others added 13 commits January 26, 2018 15:47

starting to update for Danjago2, and make updates to confgi details. …

980ee40

…swith from md to html

fixed callback, added details to error messages.

240a8e4

remove markdown from requirements.

fe74f36

Merge branch 'django_ex' of git://github.com/tremlab/bugsnag-python i…

9f79887

…nto tremlab-django_ex

fixing formatting issues, added step for middleware in README.

bb16df0

adding django1.10 version as separate app.

8e4eb45

update README, fix typo

c89fbc5

Merge branch 'master' of https://github.com/bugsnag/bugsnag-python in…

f884abd

…to django_ex

Merge branch 'django_ex' of git://github.com/tremlab/bugsnag-python i…

9abfa26

…nto tremlab-django_ex

Merge branch 'master' into tremlab-django_ex

a11639d

tests(Django): Move Django tests from example/django to tests/fixture…

ff89f55

…s/django

tests(Django): Move Django tests from example/django to tests/fixture…

28ecbd8

…s/django - Update travis.yml

tests(Django): Move Django tests from example/django to tests/fixture…

6ba784f

…s/django - Fix linter issues

Cawllec requested a review from a team May 9, 2018 16:33

$fractalwrench$

fractalwrench reviewed May 10, 2018

View reviewed changes

examples(Django): Add Django 2 example

0fe51f8

- Minor wording fixes

Cawllec changed the base branch from next to master May 10, 2018 14:14

Merge branch 'master' into tremlab-django_ex

25b1573

Merge branch 'master' into tremlab-django_ex

5d71793

$@fractalwrench$ fractalwrench self-requested a review May 11, 2018 09:15

$fractalwrench$

fractalwrench approved these changes May 11, 2018

View reviewed changes

Cawllec merged commit 7c0f794 into master May 14, 2018

Cawllec mentioned this pull request May 14, 2018

Django example app - expanding & updating #139

Closed

Cawllec deleted the tremlab-django_ex branch May 14, 2018 08:35


		STATIC_URL = '/static/'

		# Initialize Bugsnag to begin tracking errors. Only an api key is required, but here are some other helpful configuration details:

Django example updates #152

Django example updates #152

Uh oh!

Conversation

Cawllec commented May 9, 2018

Uh oh!

fractalwrench May 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fractalwrench May 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fractalwrench left a comment

Choose a reason for hiding this comment

Uh oh!

Cawllec commented May 10, 2018

Uh oh!

fractalwrench left a comment

Choose a reason for hiding this comment

Uh oh!

Cawllec commented May 11, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

$@fractalwrench$ fractalwrench May 10, 2018 •

edited

Loading

$@fractalwrench$ fractalwrench May 10, 2018 •

edited

Loading

$@fractalwrench$ fractalwrench left a comment

$@fractalwrench$ fractalwrench left a comment