jepler/chap
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

differentiate shim and library

Browse source
This commit is contained in:
Peter Kaminski 2023-10-08 07:04:12 -07:00
parent 0b886443e9
commit b4bb5d028f
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -39,9 +39,9 @@ pip install --editable .
In this mode, you get the `chap` command-line program installed, but you are able to edit the source files in the `src` directory in place.
### Via `chap.py`
### Via `chap-dev.py`
A simple shim script called `chap.py` is included to demonstrate how to load and run the `chap` library without installing `chap` in development mode. This may be more familiar to some developers.
A simple shim script called `chap-dev.py` is included to demonstrate how to load and run the `chap` library without installing `chap` in development mode. This method may be more familiar to some developers.
Change directory to the root of the `chap` project.
@ -54,7 +54,7 @@ pip install -r requirements.txt
Run the shim script (with optional command flags as appropriate):
```shell
./chap.py
./chap-dev.py
```
In this mode, you can edit the source files in the `src` directory in place, and the shim script will pick up the changes via the `import` directive.

4
chap-dev.py
View file

@ -3,7 +3,7 @@
#
# SPDX-License-Identifier: MIT
# chap.py - Simple shim script to demonstrate how to use the chap library.
# chap-dev.py - Simple shim script to demonstrate how to use the chap library.
import pathlib
import sys
@ -20,5 +20,5 @@ if __name__ == "__main__":
main()
else:
raise ImportError(
"'chap.py' is meant for direct execution, not for import."
"'chap-dev.py' is meant for direct execution, not for import."
)