Metadata-Version: 2.1
Name: frl
Version: 0.0.4
Summary: flask/requests logging
Home-page: UNKNOWN
Author: Balanced
Author-email: dev+frl@balancedpayments.com
License: The MIT License: http://www.opensource.org/licenses/mit-license.php
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: MIT License
License-File: LICENSE
Provides-Extra: client
Requires-Dist: requests ; extra == 'client'
Provides-Extra: server
Requires-Dist: Flask ; extra == 'server'
Provides-Extra: tests
Requires-Dist: nose ; extra == 'tests'
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pyflakes ; extra == 'tests'
Requires-Dist: webtest ; extra == 'tests'
Requires-Dist: WSGIProxy2 ; extra == 'tests'
Requires-Dist: mock ; extra == 'tests'
Requires-Dist: ipdb ; extra == 'tests'

# FRL Flask Requests Logger

[![Build Status](https://secure.travis-ci.org/balanced/frl.png?branch=master)](http://travis-ci.org/balanced/frl) [![Latest Version](https://pypip.in/version/frl/badge.svg)](https://pypi.python.org/pypi/frl/) [![Downloads](https://pypip.in/download/frl/badge.svg)](https://pypi.python.org/pypi/frl/) [![Supported Python versions](https://pypip.in/py_versions/frl/badge.svg)](https://pypi.python.org/pypi/frl/) [![License](https://pypip.in/license/frl/badge.svg)](https://pypi.python.org/pypi/frl/)

A request logger for requests and responses from the requests and flask libraries that logs in a standard format

```json
{
   "meta":{

   },
   "request":{
      "headers":[
         [
            "Host",
            "localhost"
         ],
         [
            "Content-Length",
            "0"
         ],
         [
            "Content-Type",
            ""
         ]
      ],
      "url":"http://localhost/",
      "method":"GET",
      "payload": null
   },
   "response":{
      "status":"200 OK",
      "headers":[
         [
            "Content-Type",
            "text/html; charset=utf-8"
         ],
         [
            "Content-Length",
            "12"
         ]
      ],
      "data":"Hello World!"
   }
}
```

## Configure flask


 ```python
 class FlaskApp(flask.Flask):

     def log_it(self, response):
         logger.log(response)
         return response

 logger = frl.server.ServerRequestLogger(
     'logger-name',
     ['card_number', 'password']
 )

 app = FlaskApp(__name__)
 app.after_request(app.log_it)

 ```


## Configure requests


```python
logger = frl.client.ClientRequestLogger(
    'logger-name',
    ['card_number', 'password']
)
response = requests.get('http://google.com')
logger.log(response)
```

You can add additional data into the meta field.

```python
logger = frl.client.ClientRequestLogger(
    'logger-name',
    ['card_number', 'password']
)
def meta_logger(response):
   return {'foo': 'bar'}
logger.meta_population_methods.append(meta_logger)
```




