codescope 0.1.26

CodeScope agent for Python

python-agent

Python agent for CodeScope

Install

pip install codescope

Usage

First, get an API key from CodeScope.

Then, prefix your startup command with codescope-run:

codescope-run -k $APIKEY python run my_app.py
codescope-run -k $APIKEY gunicorn myapp.wsgi
codescope-run -k $APIKEY python -m unittest discover

Parameters

Flag	Required?	Default	Description	Environment variable
-k, --apikey	Y		API key tog use when sending data to CodeScope	$CODESCOPE_APIKEY
-n, --name	N	default	Service name to use when sending data to CodeScope	$CODESCOPE_SERVICE
-c, --commit	N	$(git rev-parse HEAD)	Commit hash to use when sending data to CodeScope	$CODESCOPE_COMMIT_SHA
-r, --repository	N	Looked up automatically	Repository ID to use when sending data to CodeScope	$CODESCOPE_REPOSITORY
--root	N	$(git rev-parse --show-toplevel)	Repository root path	$CODESCOPE_SOURCE_ROOT

Advanced usage

If the above doesn't work for your specific setup, you can also install CodeScope agent by running the following as early as possible in your code (as it needs to patch supported libraries):

import codescope

agent = codescope.Agent(api_key="xxxxxxxx", commit="abc123", repository="github.com|1234")
agent.install()

Supported libraries

Name	Span/event creation	Extract	Inject
celery	*
gunicorn	*	*
requests	*		*
unittest	*
kombu	*	*	*
logging	*