Skip to content

Commit

Permalink
install.sh: check for and install requirements-examples.txt.
Browse files Browse the repository at this point in the history
  • Loading branch information
Gadgetoid committed Sep 4, 2024
1 parent 08aa28d commit 8538645
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
8 changes: 8 additions & 0 deletions boilerplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,14 @@ Press Ctrl+C to exit.
""")
```

If your examples need additional dependencies, then list them in:

```
requirements-examples.txt
```

Otherwise, just delete this file to avoid unecessarily prompting the user.

## Install / Uninstall Scripts

If your package directory (`PROJECT_NAME/`) differs from your library name, you should update `install.sh` and `uninstall.sh` and hard-code the correct library name.
Expand Down
15 changes: 15 additions & 0 deletions install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,12 @@ function pip_pkg_install {
check_for_error
}

function pip_requirements_install {
# A null Keyring prevents pip stalling in the background
PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring $PYTHON -m pip install -r "$@"
check_for_error
}

while [[ $# -gt 0 ]]; do
K="$1"
case $K in
Expand Down Expand Up @@ -335,6 +341,15 @@ fi

printf "\n"

if [ -f "requirements-examples.txt" ]; then
if confirm "Would you like to install example dependencies?"; then
inform "Installing dependencies from requirements-examples.txt..."
pip_requirements_install requirements-examples.txt
fi
fi

printf "\n"

# Use pdoc to generate basic documentation from the installed module

if confirm "Would you like to generate documentation?"; then
Expand Down

0 comments on commit 8538645

Please sign in to comment.