Metadata-Version: 2.1
Name: falcon-sentry
Version: 0.2.1
Summary: TODO
Home-page: https://code.richard.do/richardARPANET/falcon-sentry/
Author: Richard O'Dwyer
Author-email: richard@richard.do
License: Apache 2.0
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Dist: falcon
Requires-Dist: sentry-sdk
Requires-Dist: wheel

falcon-sentry
--------------

Installation
------------

.. code:: bash
    pip install falcon-sentry

How to use
------------

When creating your Falcon application/API instance.
Wrap it with falcon-sentry and pass in your Sentry DSN.

.. code:: python
    application = falcon.API()
    application.add_route('/items', MyResource())
    dsn = 'https://00000000000000000000000000000000@sentry.io/0000000'
    application = falcon_sentry(dsn=dsn, app=application)
    return application

You can also use an environment variable to specify the DSN.

.. code:: python
    os.environ['SENTRY_DSN'] = 'https://00000000000000000000000000000000@sentry.io/0000000'
    application = falcon_sentry(app=application)
    return application

You can specify the Sentry environment

.. code:: python
    application = falcon_sentry(dsn=dsn, app=application, environment='prod')
    return application

If both the ``dsn`` parameter and the environment variable are missing then falcon-sentry will do nothing and return the application instance.


.. :changelog:

Release History
---------------

0.2.1 (2018-12-05)
++++++++++++++++++

- Fixes packaging missing wheel.


0.2.0 (2018-12-05)
++++++++++++++++++

- Adds the ability to pass in extra arguments to sentry_sdk.init.


0.1.0 (2018-12-05)
++++++++++++++++++

- Initial release.


