Skip to main content

Create AppMap files by recording a Python application.

Project description

About

appmap-python is a Python package for recording AppMaps of your code. "AppMap" is a data format which records code structure (modules, classes, and methods), code execution events (function calls and returns), and code metadata (repo name, repo URL, commit SHA, labels, etc). It's more granular than a performance profile, but it's less granular than a full debug trace. It's designed to be optimal for understanding the design intent and structure of code and key data flows.

Usage

Visit the AppMap for Python reference page on AppLand.com for a complete reference guide.

Development

Build Status

Getting the code

Clone the repo to begin development.

% git clone https://github.com/applandinc/appmap-python.git
Cloning into 'appmap-python'...
remote: Enumerating objects: 167, done.
remote: Counting objects: 100% (167/167), done.
remote: Compressing objects: 100% (100/100), done.
remote: Total 962 (delta 95), reused 116 (delta 61), pack-reused 795
Receiving objects: 100% (962/962), 217.31 KiB | 4.62 MiB/s, done.
Resolving deltas: 100% (653/653), done.

Python version support

As a package intended to be installed in as many environments as possible, appmap-python needs to avoid using features of Python or the standard library that were added after the oldest version currently supported (see the supported versions).

Dependency management

poetry for dependency management:

% brew install poetry
% cd appmap-python
% poetry install

wrapt

The one dependency that is not managed using poetry is wrapt. Because it's possible that projects that use appmap may also need an unmodified version of wrapt (e.g. pylint depends on astroid, which in turn depends on wrapt), we use vendoring to vendor wrapt.

To update wrapt, use tox (described below) to run the vendoring environment.

Linting

pylint for linting:

% cd appmap-python
% poetry run pylint appmap

--------------------------------------------------------------------
Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)

[Note that the current configuration has a threshold set which must be met for the Travis build to pass. To make this easier to achieve, a number of checks have both been disabled. They should be reenabled as soon as possible.]

Testing

pytest

Note that you must install the dependencies contained in requirements-dev.txt before running tests. See the explanation in pyproject.toml for details.

Additionally, the tests currently require that you set APPMAP=true. You can either run pytest with appmap-python (see tox.ini), or you can explicitly set the environment variable.

pytest for testing:

% cd appmap-python
% pip install -r requirements-test.txt
% poetry run pytest

tox

Additionally, the tox configuration provides the ability to run the tests for all supported versions of Python and Django.

tox requires that all the correct versions of Python to be available to create the test environments. pyenv is an easy way to manage multiple versions of Python, and the xxenv-latest plugin can help get all the latest versions.

% brew install pyenv
% git clone https://github.com/momo-lab/xxenv-latest.git "$(pyenv root)"/plugins/xxenv-latest
% cd appmap-python
% pyenv latest local 3.{9,6,7,8}
% for v in 3.{9,6,7,8}; do pyenv latest install $v; done
% poetry run tox

Code Coverage

coverage for coverage:

% cd appmap-python
% poetry run coverage run -m pytest
% poetry run coverage html
% open htmlcov/index.html

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

appmap-2.1.6.tar.gz (113.9 kB view details)

Uploaded Source

Built Distribution

appmap-2.1.6-py3-none-any.whl (86.4 kB view details)

Uploaded Python 3

File details

Details for the file appmap-2.1.6.tar.gz.

File metadata

  • Download URL: appmap-2.1.6.tar.gz
  • Upload date:
  • Size: 113.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Linux/6.5.0-1025-gcp

File hashes

Hashes for appmap-2.1.6.tar.gz
Algorithm Hash digest
SHA256 e50508be9f0a4305b63f540a865fe6a5b26a88ba63a7b43138e42a61c5308698
MD5 80b29b2519ad72d4656024e67a3cd638
BLAKE2b-256 b0ddb281f64aff6a5b0bafdd3f9381da2ba025c8d295f3f7835f0f97ec2631f4

See more details on using hashes here.

File details

Details for the file appmap-2.1.6-py3-none-any.whl.

File metadata

  • Download URL: appmap-2.1.6-py3-none-any.whl
  • Upload date:
  • Size: 86.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Linux/6.5.0-1025-gcp

File hashes

Hashes for appmap-2.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 cae8632f0f09496ab86a94e88aebc533ba020be695fc97943467df8365976ffa
MD5 c85d7f9e2ef2596f8d7229d1d1c47f37
BLAKE2b-256 9e70a573f906b6e9687d8eef2fb96f4faa33d970b4f1c87af4f11140edd95953

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page