File tree Expand file tree Collapse file tree 1 file changed +26
-2
lines changed Expand file tree Collapse file tree 1 file changed +26
-2
lines changed Original file line number Diff line number Diff line change @@ -33,8 +33,32 @@ They are available under a `BSD license`_.
33
33
.. contents ::
34
34
35
35
36
- Quick Start
37
- ===========
36
+ Quick Start (Modern)
37
+ ====================
38
+
39
+ This guide is for versions of line profiler starting a ``4.1.0 ``.
40
+
41
+ To profile a python script:
42
+
43
+ * Install line_profiler: ``pip install line_profiler ``.
44
+
45
+ * In the relevant file(s), import line profiler and decorate function(s) you
46
+ want to profile with ``@line_profiler.profile ``.
47
+
48
+ * Set the environment variable ``LINE_PROFILE=1 `` and run your script as normal.
49
+ When the script ends a summary of profile results, files written to disk, and
50
+ instructions for inspecting details will be written to stdout.
51
+
52
+ For more details and a short tutorial see `Line Profiler Basic Usage <https://kernprof.readthedocs.io/en/latest/#line-profiler-basic-usage >`_.
53
+
54
+
55
+ Quick Start (Legacy)
56
+ ====================
57
+
58
+ This section is the original quick-start guide, and may eventually be removed
59
+ from the README. This will work with current and older (pre ``4.1.0 ``) versions
60
+ of line profiler.
61
+
38
62
To profile a python script:
39
63
40
64
* Install line_profiler: ``pip install line_profiler ``.
You can’t perform that action at this time.
0 commit comments