Re-wrote code to support Django as well flask and stand alone python.

Author: sonus21

.coveragerc

@@ -1,6 +1,6 @@
 [run]
-omit =
-    *tests.py
+include = error_tracker/*
+omit = *migrations*, *tests*
 
 [report]
 exclude_lines =

.travis.yml

@@ -1,15 +1,22 @@
 language: python
 sudo: false
-language: python
 python:
   - 2.7
+  - 3.5
+  - 3.6
+  - 3.7
+  - 3.8
 cache: pip
 install:
   - pip install -r requirements-dev.txt
-  - pip install coveralls
 
 script:
- - coverage run --source flask_error setup.py test
+  - coverage run tests/DjangoTest/runners/common_runner.py
+  - coverage run -a tests/DjangoTest/runners/custom_masking_test_runner.py
+  - coverage run -a tests/DjangoTest/runners/masking_disabled_test_runner.py
+  - coverage run -a tests/DjangoTest/runners/model_test_runner.py
+  - coverage run -a tests/DjangoTest/runners/notification_test_runner.py
+  - coverage run -a tests/flask-test-runner.py
 
 notifications:
   email:

LICENSE.rst

@@ -0,0 +1,28 @@
+Copyright 2018 Sonu Kumar
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+1.  Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+2.  Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+
+3.  Neither the name of the copyright holder nor the names of its
+    contributors may be used to endorse or promote products derived from
+    this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

LICENSE.txt

@@ -1,4 +1,4 @@
-include LICENSE.rst
+include LICENSE.txt
 include README.rst
-recursive-include flask_error/templates *
-recursive-exclude flask_error *.pyc
+recursive-include error_tracker/* *
+recursive-exclude error_tracker *.pyc

MANIFEST.in

@@ -1,56 +1,144 @@
 ==============================
-Flask Error Monitor
+Error Tracker
 ==============================
 
-Full featured error monitor app for Flask
+Full featured error tracking module for Python apps supports Flask and Django
 
-.. image:: https://travis-ci.org/sonus21/flask-error-monitor.svg?branch=master
-    :target: https://travis-ci.org/sonus21/flask-error-monitor
+.. image:: https://travis-ci.org/sonus21/error-tracker.svg?branch=master
+    :target: https://travis-ci.org/sonus21/error-tracker
 
-.. image:: https://coveralls.io/repos/github/sonus21/flask-error-monitor/badge.svg
-    :target: https://coveralls.io/github/sonus21/flask-error-monitor
+.. image:: https://coveralls.io/repos/github/sonus21/error-tracker/badge.svg
+    :target: https://coveralls.io/github/sonus21/error-tracker
 
 Introduction
 ------------
+ErrorTracker is a batteries-included app and extensions for python app, that can track errors, send notification, mask sensitive data and capture frames data.
 
-Flask-Error-Monitor is a batteries-included, simple-to-use `Flask <http://flask.pocoo.org/>`_ extension that lets you
-add error recording interfaces to Flask applications. It's implemented in such a way that the developer has total control of the resulting application.
+It plays nicely with `Django <https://www.djangoproject.com/>`_ and `Flask <http://flask.pocoo.org/>`_
 
-Out-of-the-box, Flask-Error-Monitor plays nicely with various ORM's, including
+Simple to use  extension that lets you add error recording interfaces to Python applications.
+It's implemented in such a way that the developer has total control of the resulting application.
 
-- `SQLAlchemy <http://www.sqlalchemy.org/>`_,
+Out-of-the-box, Error Tracker plays nicely with various ORM's, including
 
+- `SQLAlchemy <http://www.sqlalchemy.org/>`_,
 - `MongoEngine <http://mongoengine.org/>`_,
+- `Django ORM <https://tutorial.djangogirls.org/en/django_orm/>`_
 
 
 It also boasts a simple Model management interface.
 
-The biggest feature of Flask-Error-Monitor is flexibility. To start off with you can create a very simple application in no time,
+The biggest feature of ErrorTracker is flexibility. To start off with you can create a very simple application in no time,
 with exception monitor enabled, but then you can go further and customize different aspects.
 
-Flask-Error-Monitor is an active project, well-tested and production ready.
+ErrorTracker is an active project, well-tested and production ready.
 
 Installation
 ------------
-To install Flask-Error-Monitor, simply::
+To install ErrorTracker, simply::
 
-    git clone git@github.com:sonus21/flask-error-monitor.git
-    cd flask-error-monitor
-    python setup.py install
+    pip install error-tracker
 
 
 Features
--------------
+--------
 - Sensitive data( like *password*, *secret* ) Masking
 - Record all the frames ( frame data are stored in JSON format so that it can be analyzed later)
 - Unique URL generation
 - Number of times the exception occurred and first/last time of exception
-- Sending emails with exception details
+- Sending notifications with exception details
 - Record different types of exception like 500 or 404 etc
+- Raise or update ticket in Jira/Bugzilla etc by ticketing interface.
+
+Usage
+-----
+
+Flask App configuration
+=======================
+
+.. code::
+
+    ...
+    APP_ERROR_SEND_EMAIL = True
+    APP_ERROR_RECIPIENT_EMAIL = ('example@example.com',)
+    APP_ERROR_SUBJECT_PREFIX = "Server Error"
+    APP_ERROR_EMAIL_SENDER = 'user@example.com'
+
+
+
+app.py
+
+.. code::
+
+    from flask import Flask
+    from flask_mail import Mail
+    import settings
+    from error_tracker import AppErrorTracker, NotificationMixin
+    from flask_sqlalchemy import SQLAlchemy
+    ...
+    app = Flask(__name__)
+    app.config.from_object(settings)
+    db = SQLAlchemy(app)
+    class Notifier(Mail, NotificationMixin):
+        def notify(self, request, exception,
+                   email_subject=None,
+                   email_body=None,
+                   from_email=None,
+                   recipient_list=None):
+            message = Message(email_subject, recipient_list, email_body, sender=from_email)
+            self.send(message)
+    mailer = Notifier(app=app)
+    error_tracker = AppErrorTracker(app=app, db=db, notifier=mailer)
+
+    ....
+
+    ....
+    # Record exception when 404 error code is raised
+    @app.errorhandler(403)
+    def error_403(e):
+        error_tracker.record_exception()
+        # any custom logic
+
+    # Record error using decorator
+    @app.errorhandler(500)
+    @error_tracker.track_exception
+    def error_500(e):
+        # some custom logic
+    ....
+
+
+Django App Usage
+================
+
+We need to update settings.py file as
+
+-  Add app to installed apps list
+-  Add Middleware for exception tracking. This should be added at the end so that it can process exception 1st in the middleware call stack.
+-  Other configs related to notification
+
+Sample Code
+
+
+.. code::
+
+    ...
+    APP_ERROR_RECIPIENT_EMAIL = ('example@example.com',)
+    APP_ERROR_SUBJECT_PREFIX = "Server Error"
+    APP_ERROR_EMAIL_SENDER = 'user@example.com'
+
+    INSTALLED_APPS = [
+        ...
+        'error_tracker.DjangoErrorTracker'
+    ]
+    MIDDLEWARE = [
+        ...
+        'error_tracker.django.middleware.ExceptionTrackerMiddleWare'
+    ]
+
 
 Documentations
--------------
-This has got extensive document browse at https://flask-error-monitor.readthedocs.io/en/latest/
+--------------
+This has got extensive document browse at https://error-tracker.readthedocs.io/en/latest/
 
 All docs are in `docs/source`
 
@@ -62,27 +150,36 @@ Examples
 Several usage examples are included in the */tests* folder. Please feel free to add your own examples, or improve
 on some of the existing ones, and then submit them via GitHub as a *pull-request*.
 
-You can see some of these examples in action at https://github.com/sonus21/flask-error-monitor/tree/master/examples.
+You can see some of these examples in action at https://github.com/sonus21/error-tracker/tree/master/examples
 To run the examples on your local environment, one at a time, do something like::
 
-    cd flask-error-monitor
-    python examples/simple/app.py
+    cd error-tracker/examples
+
+
+Django::
+
+    cd error-tracker/examples
+     cd DjangoSample
+     python manage.py runserver
+
+Flask::
+
+      cd flask-sample
+      python app.py
 
 
 Tests
 -----
-Test are run with *nose*. If you are not familiar with this package you can get some more info from `their website <https://nose.readthedocs.io/>`_.
-
 To run the tests, from the project directory, simply::
 
     pip install -r requirements-dev.txt
-    nosetests
+    bash tests/run-tests.sh
 
 You should see output similar to::
 
     .............................................
     ----------------------------------------------------------------------
-    Ran 26 tests in 1.144s
+    Ran 29 tests in 1.144s
 
     OK
 

README.rst

@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = flask-error-monitor
+SPHINXPROJ    = error-tracker
 SOURCEDIR     = source
 BUILDDIR      = build
 

docs/Makefile

@@ -9,7 +9,7 @@ if "%SPHINXBUILD%" == "" (
 )
 set SOURCEDIR=source
 set BUILDDIR=build
-set SPHINXPROJ=flask-error-monitor
+set SPHINXPROJ=error-tracker
 
 if "%1" == "" goto help
 

docs/make.bat

@@ -14,13 +14,13 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../flask_error'))
+sys.path.insert(0, os.path.abspath('../error_tracker'))
 
 
 # -- Project information -----------------------------------------------------
 
-project = u'flask-error-monitor'
-copyright = u'2018, Sonu Kumar'
+project = u'error-tracker'
+copyright = u'2019, Sonu Kumar'
 author = u'Sonu Kumar'
 
 # The short X.Y version
@@ -107,7 +107,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'flask-error-monitordoc'
+htmlhelp_basename = 'error-tracker-doc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -134,7 +134,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'flask-error-monitor.tex', u'flask-error-monitor Documentation',
+    (master_doc, 'error-tracker.tex', u'error-tracker Documentation',
      u'Sonu Kumar', 'manual'),
 ]
 
@@ -144,7 +144,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'flask-error-monitor', u'flask-error-monitor Documentation',
+    (master_doc, 'error-tracker', u'error-tracker Documentation',
      [author], 1)
 ]
 
@@ -155,8 +155,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'flask-error-monitor', u'flask-error-monitor Documentation',
-     author, 'flask-error-monitor', 'One line description of project.',
+    (master_doc, 'error-tracker', u'error-tracker Documentation',
+     author, 'error-tracker', 'Error Tracker Modules for Flask, Django and Python',
      'Miscellaneous'),
 ]