fix: security and reliability improvements

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: ''
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Python code**
+Relevant Python code to reproduce the problem
+
+**Javascript code**
+Relevant Javascript code to reproduce the problem
+
+**Expected behavior**
+A description of what you expected to happen.
+
+**Actual behavior**
+A description of what actually happened.
+
+**Other Information (please complete the following information):**
+
+- OS: [e.g. Windows10]
+- Python Version [e.g. 3.6]
+- Node Version [e.g. 12]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'enhancement'
+assignees: ''
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,14 @@
+---
+name: Question
+about: A question about python-shell
+title: ''
+labels: 'question'
+assignees: ''
+---
+
+<!--If you are having a problem inside your python code please do not create a issue here.
+Python-shell just runs your python code, it is not responsible for any errors in the code itself.-->
+
+**The Question**:
+
+**Any relevant python/javascript code:**

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        node-version: [18, 20, 22]
+        python-version: ['3.10', '3.12']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: npm install
+      - run: npm test

.gitignore

@@ -1 +1,118 @@
 node_modules
+npm-debug.log.*
+.vscode
+personal
+*.js
+*.js.map
+*.d.ts
+.nyc_output
+coverage
+*.code-workspace
+
+# DEFAULT PYTHON GITIGNORE
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+.static_storage/
+.media/
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

.prettierignore

@@ -0,0 +1 @@
+package-lock.json

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "semi": true,
+  "singleQuote": true
+}

.vscode/launch.json

@@ -0,0 +1,48 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Current TS File",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": [
+        "--nolazy",
+        "-r",
+        "ts-node/register"
+      ],
+      "sourceMaps": true,
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+    },
+    {
+      "name": "Python",
+      "type": "python",
+      "request": "launch",
+      "stopOnEntry": true,
+      "python": "${command:python.interpreterPath}",
+      "program": "${file}",
+      "cwd": "${workspaceRoot}",
+      "env": {},
+      "envFile": "${workspaceRoot}/.env",
+    },
+    {
+      "name": "Current TS Tests File",
+      "type": "node",
+      "request": "launch",
+      "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
+      "args": [
+        "-r",
+        "ts-node/register",
+        "${relativeFile}",
+        "--ui",
+        "tdd",
+        "--no-timeouts"
+      ],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector"
+    }
+  ]
+}

CHANGELOG.md

@@ -1,10 +1,74 @@
-## 0.0.3
-* fixed buffering in `PythonShell.receive`, fixing [#1](https://github.com/extrabacon/python-shell/issues/1)
+## [5.0.0] - 2023-02-10
 
-## 0.0.2
-* improved documentation
+### BREAKING CHANGES
 
-## 0.0.1
-* initial version
-* independent module moved from [extrabacon/pyspreadsheet](https://github.com/extrabacon/pyspreadsheet)
+- run and runString now return a promise instead of a using a callback.
+- You will need to 1) check the return value, 2) remove the callback argument, and 3) change to a promise
+- see readme for usage examples
 
+### Other notes
+
+- I confirmed that python-shell works with python 3.11 and node v18.
+
+## [4.0.0] - 2023-02-10
+
+### Changed
+
+- run and runString now return a promise instead of a using a callback.
+- This is somewhat backwards compatible with previous behavior
+
+## [3.0.1] - 2021-10-09
+
+### Fixed
+
+- Previously when you called the kill method the terminated attribute was always set to true, regardless of whether the process was actually killed. Now the terminated boolean is set to true if kill succeeds, false otherwise. [#255](https://github.com/extrabacon/python-shell/issues/255)
+
+## [3.0.0] - 2021-03-07
+
+### Changed
+
+- **BREAKING** Default python path changed back to `python` on Windows. [#237](https://github.com/extrabacon/python-shell/issues/237)
+- **BREAKING** `error` event renamed to `pythonError` event. [#118](https://github.com/extrabacon/python-shell/issues/118)
+- **BREAKING** `receive` methods removed in favor of `splitter` arguments in the constructor. This lets the default splitting logic reside in a reuseable stream transformer. Now if you have extra pipes you can reuse `newlineTransformer` to split incoming data into newline-seperated lines.
+
+### Added
+
+- `error` event that is fired upon failure to launch process, among other things. [#118](https://github.com/extrabacon/python-shell/issues/118)
+
+## [1.0.8]
+
+### Fixed
+
+- @joaoe fixed a bug with pythonshell not working with unset std streams
+- https://github.com/extrabacon/python-shell/milestone/9
+
+## [1.0.7]
+
+### Changed
+
+- default python path updated to py on windows
+
+## [1.0.4]
+
+### Added
+
+- added getVersionSync
+
+## [0.0.3]
+
+### Fixed
+
+- fixed buffering in `PythonShell.receive`, fixing [#1](https://github.com/extrabacon/python-shell/issues/1)
+
+## [0.0.2]
+
+### Changed
+
+- improved documentation
+
+## [0.0.1]
+
+### Added
+
+- initial version
+- independent module moved from [extrabacon/pyspreadsheet](https://github.com/extrabacon/pyspreadsheet)