AppSignal Python Installation

This documentation walks you through the steps needed to add the AppSignal package to your application. New to AppSignal? We recommend following our installation guide first.

Requirements

Before you can run AppSignal, make sure your application’s Operating System is supported.

Installation

First, sign up for an AppSignal account and add the AppSignal for Python integration package to your requirements.txt file:

Python

# requirements.txt
appsignal

Then, install the package and run our automated install tool, which will create an __appsignal__.py file in your project:

Bash

pip install -r requirements.txt
python -m appsignal install

If the pip and python executables do not work, please use the pip3 and python3 executables instead.

Manual installation

You can also skip the automated tool and create the __appsignal__.py file manually:

Python

from appsignal import Appsignal

appsignal = Appsignal(
    name="My app name",
    push_api_key="my-push-api-key",
    active=True
)

Installing instrumentation packages

The AppSignal package does not automatically instrument any libraries. AppSignal offers support for a number of popular Python libraries, you can learn more about how to instrument these libraries in our Instrumentations documentation:

• Celery
• Django
• FastAPI
• Flask
• Jinja2
• MySQL
• PostgreSQL
• Redis
• Requests
• Starlette
• WSGI/ASGI

Configuration

After installing AppSignal and all necessary packages, you can read the Configuration documentation to learn how to report data to AppSignal.