Skip to content

Commit 74d0b63

Browse files
committed
update readme for pythonPath
1 parent f4b2546 commit 74d0b63

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# [python-shell](https://www.npmjs.com/package/python-shell) [![Build status](https://ci.appveyor.com/api/projects/status/m8e3h53vvxg5wb2q/branch/master?svg=true)](https://ci.appveyor.com/project/Almenon/python-shell/branch/master) [![codecov](https://codecov.io/gh/extrabacon/python-shell/branch/master/graph/badge.svg)](https://codecov.io/gh/extrabacon/python-shell)
22

3-
<!-- chage above url accroding to repo -->
3+
<!-- change above url according to repo -->
44
A simple way to run Python scripts from Node.js with basic but efficient inter-process communication and better error handling.
55

66
## Features
@@ -11,17 +11,15 @@ A simple way to run Python scripts from Node.js with basic but efficient inter-p
1111
+ Simple and efficient data transfers through stdin and stdout streams
1212
+ Extended stack traces when an error is thrown
1313

14+
## Requirements
15+
First make sure you are able to run `python3` (Mac/Linux) or `python` (Windows) from the terminal. If you are not then you might need to add it to the PATH. If you want to use a version of python not in the PATH you should specify `options.pythonPath`.
16+
1417
## Installation
1518

1619
```bash
1720
npm install python-shell
1821
```
1922

20-
To run the tests:
21-
```bash
22-
npm test
23-
```
24-
2523
## Documentation
2624

2725
### Running python code:
@@ -170,7 +168,7 @@ Creates an instance of `PythonShell` and starts the Python process
170168
* `parser`: each line of data (ending with "\n") is parsed with this function and its result is emitted as a message
171169
* `stderrParser`: each line of logs (ending with "\n") is parsed with this function and its result is emitted as a message
172170
* `encoding`: the text encoding to apply on the child process streams (default: "utf8")
173-
* `pythonPath`: The path where to locate the "python" executable. Default: "python3" ("py" for Windows)
171+
* `pythonPath`: The path where to locate the "python" executable. Default: "python3" ("python" for Windows)
174172
* `pythonOptions`: Array of option switches to pass to "python"
175173
* `scriptPath`: The default path where to look for scripts. Default is the current working directory.
176174
* `args`: Array of arguments to pass to the script

0 commit comments

Comments
 (0)