https://github.com/spyder-ide/spyder-line-profiler

This is a plugin to run the python line profiler from within the spyder editor.
https://github.com/spyder-ide/spyder-line-profiler

profiler python spyder spyder-plugin

Last synced: 3 months ago
JSON representation

This is a plugin to run the python line profiler from within the spyder editor.

• Host: GitHub
• URL: https://github.com/spyder-ide/spyder-line-profiler
• Owner: spyder-ide
• License: mit
• Created: 2015-09-03T02:45:19.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2025-03-10T16:55:07.000Z (7 months ago)
• Last Synced: 2025-06-21T01:36:11.082Z (4 months ago)
• Topics: profiler, python, spyder, spyder-plugin
• Language: Python
• Homepage:
• Size: 379 KB
• Stars: 35
• Watchers: 7
• Forks: 13
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

          
# Spyder line profiler plugin

## Project details

![license](https://img.shields.io/pypi/l/spyder-line-profiler.svg)

[![conda version](https://img.shields.io/conda/v/conda-forge/spyder-line-profiler.svg)](https://www.anaconda.com/download/)

[![download count](https://img.shields.io/conda/d/conda-forge/spyder-line-profiler.svg)](https://www.anaconda.com/download/)

[![pypi version](https://img.shields.io/pypi/v/spyder-line-profiler.svg)](https://pypi.python.org/pypi/spyder-line-profiler)

[![Join the chat at https://gitter.im/spyder-ide/public](https://badges.gitter.im/spyder-ide/spyder.svg)](https://gitter.im/spyder-ide/public)

[![OpenCollective Backers](https://opencollective.com/spyder/backers/badge.svg?color=blue)](#backers)

[![OpenCollective Sponsors](https://opencollective.com/spyder/sponsors/badge.svg?color=blue)](#sponsors)

## Build status

[![Windows status](https://github.com/spyder-ide/spyder-line-profiler/workflows/Windows%20tests/badge.svg)](https://github.com/spyder-ide/spyder-line-profiler/actions?query=workflow%3A%22Windows+tests%22)

[![Linux status](https://github.com/spyder-ide/spyder-line-profiler/workflows/Linux%20tests/badge.svg)](https://github.com/spyder-ide/spyder-line-profiler/actions?query=workflow%3A%22Linux+tests%22)

[![MacOS status](https://github.com/spyder-ide/spyder-line-profiler/workflows/Macos%20tests/badge.svg)](https://github.com/spyder-ide/spyder-line-profiler/actions?query=workflow%3A%22Macos+tests%22)

[![codecov](https://codecov.io/gh/spyder-ide/spyder-line-profiler/branch/master/graph/badge.svg)](https://codecov.io/gh/spyder-ide/spyder-line-profiler/branch/master)

## Description

This is a plugin to run the Python

[line_profiler](https://pypi.python.org/pypi/line_profiler)

from within the Python IDE [Spyder](https://github.com/spyder-ide/spyder).

The code is an adaptation of the profiler plugin integrated in Spyder.

## Installation

To install this plugin, you can use either ``pip`` or ``conda`` package

managers, as follows:

Using conda (the recommended way!):

```

conda install spyder-line-profiler -c conda-forge

```

Using pip:

```

pip install spyder-line-profiler

```

## Usage

Add a `@profile` decorator to the functions that you wish to profile then

Shift+F10 (line profiler default) to run the profiler on the current script,

or go to `Run > Run line profiler`.

The results will be shown in a dockwidget, grouped by function. Lines with a

stronger color take more time to run.

## Screenshot

![Screenshot of spyder-line-profiler plugin showing profiler results](./img_src/screenshot_profiler.png)

## Contributing

Everyone is welcome to contribute!

## Sponsors

Spyder and its subprojects are funded thanks to the generous support of

[![Quansight](https://static.wixstatic.com/media/095d2c_2508c560e87d436ea00357abc404cf1d~mv2.png/v1/crop/x_0,y_9,w_915,h_329/fill/w_380,h_128,al_c,usm_0.66_1.00_0.01/095d2c_2508c560e87d436ea00357abc404cf1d~mv2.png)](https://www.quansight.com/)[![Numfocus](https://i2.wp.com/numfocus.org/wp-content/uploads/2017/07/NumFocus_LRG.png?fit=320%2C148&ssl=1)](https://numfocus.org/)

and the donations we have received from our users around the world through [Open Collective](https://opencollective.com/spyder/):

[![Sponsors](https://opencollective.com/spyder/sponsors.svg)](https://opencollective.com/spyder#support)