Skip to content

Commit

Permalink
Docs: Convert README to Markdown and update badges
Browse files Browse the repository at this point in the history
  • Loading branch information
jitseniesen committed Apr 11, 2020
1 parent 4e747b3 commit 4e42f21
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 65 deletions.
71 changes: 71 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# 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/spyder-ide/spyder-line-profiler.svg)](https://www.anaconda.com/download/)
[![download count](https://img.shields.io/conda/d/spyder-ide/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)
[![Crowdin](https://badges.crowdin.net/spyder-line-profiler/localized.svg)](https://crowdin.com/project/spyder-line-profiler)

## 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 spyder-ide
```

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 > Profile line by line`.

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_profler.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)
65 changes: 0 additions & 65 deletions README.rst

This file was deleted.

0 comments on commit 4e42f21

Please sign in to comment.