Development Guidelines

Install

Clone this repository with git:

git clone git@github.com:crusaderky/pshell.git
cd pshell

Install Python (OS-dependent)
```
pip install -r requirements.txt
```

To keep a fork in sync with the upstream source:

cd pshell
git fetch -a upstream
git checkout main
git pull upstream main
git push origin main

Test

Test using py.test:

py.test pshell

Code Formatting

pshell uses several code linters (ruff, black, mypy), which are enforced by CI. Developers should run them locally before they submit a PR, through the single command

pre-commit run --all-files

This makes sure that linter versions and options are aligned for all developers.

Optionally, you may wish to setup the pre-commit hooks to run automatically when you make a git commit. This can be done by running:

pre-commit install

from the root of the pshell repository. Now the code linters will be run each time you commit changes. You can skip these checks with git commit --no-verify or with the short version git commit -n.