Install the Python agent

Install the Python agent on your system.


Quickstart

Installing the Sqreen Python agent enables you to monitor the security of your application and block attacks in real-time. Installing Python in your application takes less than a minute:

  • Sign up to Sqreen to create your account.
  • Pick up your first application name and language. The name of the application can be the name of the repository, or anything that helps you identify the app in your Sqreen dashboard.
  • Follow the procedure detailed below.

We support two ways of protecting your app:

  • Change your wsgi file to include the Sqreen code
  • Use our command-line launcher to launch your application

Standard Python Application

If you control the way your web application (or WSGI server) starts follow the simple instructions below.

pip > 8.1.0 required

Make sure you have a pip version > 8.1.0. pip install -U pip

In a terminal, install Sqreen using pip:

pip install sqreen

Then in your application root directory use the following command to set up your Sqreen configuration (the Sqreen token is provided in your user interface):

echo -e "[sqreen]\ntoken: mysecrettoken" > sqreen.ini

Finally, from your application root directory, change your application file (typically a wsgi.py or app.py file) by inserting these two lines at the (very) top:

import sqreen
sqreen.start()

Command-line Sqreen launcher

You can use our CLI (command-line) launcher to start your application with Sqreen from a terminal:

sqreen-start gunicorn YOUR_APP.wsgi

Install the agent on non production environments

Typically you install the Sqreen agent in your production environment, but you can create several applications using your Sqreen dashboard, and specify the environment (development, staging, production). A unique Sqreen token is provided for each of your applications.

Basic configuration

After installing the agent, your configuration will be stored in the configuration file sqreen.ini. It contains your Sqreen token.

Instead of using the Sqreen configuration file sqreen.ini, you can also use the SQREEN_TOKEN environment variable to set up your token:

export SQREEN_TOKEN=mysecrettoken

The Sqreen Python agent provides flexible configuration settings. Refer to Configuration of the Python agent for more detailed information.

Install the agent on Alpine Linux

On Alpine, you need to install Sqreen a bit differently. Run the following commands.

apk add libgcc
pip install --no-cache --index-url https://download.sqreen.com/python/alpine py-mini-racer
pip install sqreen

Basic configuration

After installing the agent, your configuration will be stored in the configuration file sqreen.ini. It contains your Sqreen token.

Instead of using the Sqreen configuration file sqreen.ini, you can also use the SQREEN_TOKEN environment variable to set up your token:

export SQREEN_TOKEN=mysecrettoken

The Sqreen Python agent provides flexible configuration settings. Refer to Configuration of the Python agent for more detailed information.

Uninstall the Agent

To uninstall the Sqreen agent, remove the module from your application.

Notes

The Sqreen Python agent is available on PyPI repository.

Use different Sqreen Applications for different environments

We recommend you to use different Sqreen applications on your different environments: Production, Staging and Development.