-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add "why exists" comments to shell scripts
- Loading branch information
1 parent
4944f1a
commit 3f38894
Showing
2 changed files
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,22 @@ | ||
#!/usr/bin/env bash | ||
# | ||
# spiderhost.sh exists only as a thin wrapper for spiderhost.py. | ||
# | ||
# What's the point of spiderhost.sh? Collections of spiders are | ||
# packaged in docker images and Cloudfeaster Services | ||
# exposes a RESTful API that enables discovery and execution | ||
# of spiders packaged in the docker images. Wanted to | ||
# be able to describe the API exposed by a docker image | ||
# containing spiders in a "platform neutral" way. What does | ||
# "platform neutral" mean in this context? Although this | ||
# project advocates for spiders being written using Python | ||
# and Webdriver there may be better approaches for authoring | ||
# some types of spiders while still wanting to use the | ||
# Cloudfeaster Services infrastructure. By creating this | ||
# and other shell script wrappers, the docker images API | ||
# can be described in ways that does not include any | ||
# reference to Python and Webdriver. | ||
# | ||
|
||
spiderhost.py "$@" | ||
exit $? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,22 @@ | ||
#!/usr/bin/env bash | ||
# | ||
# spiders.sh exists only as a thin wrapper for spiders.py. | ||
# | ||
# What's the point of spiders.sh? Collections of spiders are | ||
# packaged in docker images and Cloudfeaster Services | ||
# exposes a RESTful API that enables discovery and execution | ||
# of spiders packaged in the docker images. Wanted to | ||
# be able to describe the API exposed by a docker image | ||
# containing spiders in a "platform neutral" way. What does | ||
# "platform neutral" mean in this context? Although this | ||
# project advocates for spiders being written using Python | ||
# and Webdriver there may be better approaches for authoring | ||
# some types of spiders while still wanting to use the | ||
# Cloudfeaster Services infrastructure. By creating this | ||
# and other shell script wrappers, the docker images API | ||
# can be described in ways that does not include any | ||
# reference to Python and Webdriver. | ||
# | ||
|
||
spiders.py "$@" | ||
exit $? |