Metadata-Version: 1.1
Name: tornado-profile
Version: 1.2.0
Summary: Profile a Tornado application via REST
Home-page: https://github.com/makearl/tornado-profile
Author: Megan Kearl Patten
Author-email: megkearl@gmail.com
License: MIT
Description: Profile a Tornado application through a REST API
        ================================================
        
        .. image:: https://travis-ci.org/makearl/tornado-profile.svg?branch=master
            :target: https://travis-ci.org/makearl/tornado-profile
        
        Add this library to your routes to add a REST API for profiling your Tornado application.
        
        
        Usage
        -----
        
        .. code-block::
        
            import tornado
            from tornado_profile import TornadoProfiler
        
            port = 8888
            routes = []
        
            routes += TornadoProfiler().get_routes()
            app = tornado.web.Application(routes)
            app.listen(port)
            tornado.ioloop.IOLoop.current().start()
        
            # Create with optional route prefix and base class for handlers
            routes += TornadoProfiler(prefix="", handler_base_class=custom_base_class).get_routes()
        
        
        Installation
        ------------
        
        .. code-block::
        
            $ pip install tornado-profile
        
        
        API
        ---
        
        .. code-block::
        
            # Start the profiler
            POST /profiler
        
            # Stop the profiler
            DELETE /profiler
        
            # Get the profiler status
            GET /profiler
            {"running": true/false}
        
            # Get the profiler statistics
            GET /profiler/stats
            {
                "statistics": [
                    {
                        "path": ...,
                        "line": ...,
                        "func_name": ...,
                        "num_calls": ...,
                        "total_time": ...,
                        "total_time_per_call": ...,
                        "cum_time": ...,
                        "cum_time_per_call": ...
                    }
                    ...
                ]
            }
        
            # Get the profiler statistics with optional query parameters
            GET /profiler/stats?count=1&sort=num_calls&strip_dirs=false
        
            # Clear the profiler statistics
            DELETE /profiler/stats
        
        
        Tools
        -----
        Command Line: https://github.com/dimrozakis/tornado-profile-client
        
Keywords: tornado profile profiler rest
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Utilities
