Install the Python agent

Install the Python agent on your system.


Quickstart

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

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.

# Set the Sqreen token and the app name, including the environment
cat > sqreen.ini <<EOF
[sqreen]
app_name: YOUR_APPLICATION_NAME
token: SQREEN_TOKEN
EOF

Lastly, from your application root directory, change your application file (typically a wsgi.py or app.py file) by inserting these two lines at the 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

{!partials/install-agent-multiple-envs.md!}

# Set the Sqreen token and the app name, including the environment
cat > sqreen.ini <<EOF
[sqreen]
app_name: foobar (production)
token: SQREEN_TOKEN
EOF

Basic configuration

The Sqreen agent stores your configuration in the sqreen.ini file.

{!partials/install-agent-env-vars.md!}

export SQREEN_APP_NAME="YOUR_APPLICATION_NAME"
export SQREEN_TOKEN="SQREEN_TOKEN"

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

Uninstall the agent

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

Notes

The Sqreen Python agent is available in the 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.