Skip to content

Commit

Permalink
add "why exists" comments to shell scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
simonsdave committed May 29, 2018
1 parent 4944f1a commit 3f38894
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
18 changes: 18 additions & 0 deletions bin/spiderhost.sh
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 $?
18 changes: 18 additions & 0 deletions bin/spiders.sh
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 $?

0 comments on commit 3f38894

Please sign in to comment.