i8t 0.0.2

No project description provided

i8t instruments Python code to send checkpoints to i8t server.

Installation

pip install i8t

Usage

i8t can be used in a few ways:

1. Instrument all inbound web requests (currently only Flask is supported):

   import flask
   import requests
   from i8t.instrument.flask_introspection import FlaskIntrospection
   
   app = flask.Flask(__name__)
   
   app.route("/test", methods=["POST"])
   def test_route():
       return "Test Response", 200
   
   introspection_client = IntrospectionClient(
       session=requests.Session(),
       api_url="https://api.demin.dev/i8t/checkpoints/unique-tenant-id",
       name="app",
   )
   flask_introspection = FlaskIntrospection(introspection_client)
   flask_introspection.register(app)

2. Instrument all outbound HTTP requests (currently only requests is supported):

   import requests
   from i8t.instrument.requests_introspection import RequestsIntrospection
   
   introspection_client = IntrospectionClient(
       session=requests.Session(),
       api_url="https://api.demin.dev/i8t/checkpoints/unique-tenant-id",
       name="app",
   )
   requests_introspection = RequestsIntrospection(introspection_client)
   requests_introspection.register()

3. Decorate any function to send its inputs and outputs:

   from i8t.client import IntrospectionClient, IntrospectionDecorator, introspect
   
   @introspect
   def test_func(first, second):
       return first + second
   
   introspection_client = IntrospectionClient(
       session=requests.Session(),
       api_url="https://api.demin.dev/i8t/checkpoints/unique-tenant-id",
       name="app",
   )
   decorator = IntrospectionDecorator(introspection_client)
   decorator.register()

Once initialized, the inputs and outputs of the instrumented calls are sent to the i8t server, where they can be later fetched at the same URL.

The fetched call checkpoints can be used to set up canned tests.