https://github.com/howfast/apm-python

APM agent for Python and Flask
https://github.com/howfast/apm-python

apm flask flask-middleware howfast performance

Last synced: about 1 month ago
JSON representation

APM agent for Python and Flask

• Host: GitHub
• URL: https://github.com/howfast/apm-python
• Owner: HowFast
• License: mit
• Created: 2019-08-31T05:08:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-24T00:58:40.000Z (5 months ago)
• Last Synced: 2025-04-09T05:33:56.565Z (about 1 month ago)
• Topics: apm, flask, flask-middleware, howfast, performance
• Language: Python
• Homepage: https://www.howfast.tech/application-performance-monitoring/
• Size: 271 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# HowFast APM agent for Python

[![PyPI](https://img.shields.io/pypi/v/howfast-apm)](https://pypi.org/project/howfast-apm/)

[![CircleCI](https://circleci.com/gh/HowFast/apm-python.svg?style=svg)](https://circleci.com/gh/HowFast/apm-python)

[![uptime](https://badge.howfast.tech/uptime.png?t=https%3A%2F%2Fwww.howfast.tech%2F)](https://www.howfast.tech/#/monitors/https:%2F%2Fwww.howfast.tech%2F?pk_campaign=badge)

[![Coverage Status](https://coveralls.io/repos/github/HowFast/apm-python/badge.svg?branch=master)](https://coveralls.io/github/HowFast/apm-python?branch=master)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/howfast-apm)

![PyPI - Downloads](https://img.shields.io/pypi/dw/howfast-apm)

This Python APM (Application Performance Monitoring) agent sends performance data to your

[HowFast](https://www.howfast.tech/) account.

It only supports Flask for now.

![Screenshot of HowFast APM](./screenshot.png)

## Usage

```bash

pip install howfast-apm[flask]

```

Then, follow the instructions detailed in [the package page](https://pypi.org/project/howfast-apm/).

## Develop

```bash

# Install dependencies, including the one needed to develop

poetry install -v -E flask

# To build a new version

poetry build

poetry publish

```

## Test

```bash

# Lint the code

poetry run flake8 howfast_apm

# Running the tests

poetry run pytest

# Running the tests across a matrix of Python versions and Flask versions

pip install tox tox-pyenv

tox

```

## Publish

```bash

# Replace "minor" by "patch" or "major" depending how you want to bump the version

poetry version minor

# Commit the changes

git add pyproject.toml && git commit -m "Bump version"

# Build and publish

poetry publish --build

```