Skip to content
Browse files

adding license, contributing info, better deploy timeout and feedback

  • Loading branch information...
1 parent b62efc6 commit bb968669d37db94e21e59e09162bcfcabd6637f8 @progrium committed Sep 17, 2012
Showing with 38 additions and 9 deletions.
  1. +20 −0 LICENSE
  2. +14 −6 README.md
  3. +4 −3 skypipe/cloud.py
View
20 LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jeff Lindsay
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+“Software”), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
20 README.md
@@ -4,12 +4,10 @@ Skypipe is a magical command line tool that lets you easily pipe data across ter
## Installing
-Currently you need Python 2.7 and the ability to compile extensions.
-Then grab from Github and install:
+Currently you need Python 2.6 and the ability to compile extensions.
+Then install with pip from Github:
- $ git clone git://github.com/progrium/skypipe.git
- $ cd skypipe
- $ python setup.py install
+ $ pip install -e git+git://github.com/progrium/skypipe.git#egg=skypipe
## Setting up
@@ -19,7 +17,7 @@ you will be asked for credentials.
## Using Skypipe
-Skypipe combines named pipes and netcat and gives you even more power in a simpler tool. Here is a simple example using an unnamed skypipe like you would a regular named pipe in order to gzip a file across shells:
+Skypipe combines named pipes and netcat and gives you even more power in a simpler tool. Here is a simple example using skypipe like you would a named pipe in order to gzip a file across shells:
$ skypipe | gzip -9 -c > out.gz
@@ -70,6 +68,16 @@ This represents a new paradigm of creating tools that transparently leverage the
Thanks to platforms like dotcloud (and Heroku), we can now build software leveraging features of software as a service that is *packaged and distributed like normal open source software*.
+## Contributing
+
+There aren't any tests yet, but it's pretty well documented and the code
+is written to be read. Fork and send pull requests. Check out the issues
+to see how you can be most helpful.
+
+## Contributors
+
+* Jeff Lindsay <progrium@gmail.com>
+
## License
MIT
View
7 skypipe/cloud.py
@@ -53,7 +53,7 @@ def setup_dotcloud_account(cli):
cli.setup_auth()
cli.get_keys()
-def discover_satellite(cli):
+def discover_satellite(cli, timeout=10):
"""Looks to make sure a satellite exists, returns endpoint
First makes sure we have dotcloud account credentials. Then it looks
@@ -74,7 +74,7 @@ def discover_satellite(cli):
host = socket.gethostbyname(environ['DOTCLOUD_SATELLITE_ZMQ_HOST'])
endpoint = "tcp://{0}:{1}".format(host, port)
- ok = client.check_skypipe_endpoint(endpoint)
+ ok = client.check_skypipe_endpoint(endpoint, timeout)
if ok:
#cli.info("DEBUG: Found satellite") # TODO: remove
return endpoint
@@ -147,5 +147,6 @@ class args: path = satellite_path
# workaround for a bug in the current dotcloud client code
pass
- return discover_satellite(cli)
+ cli.info("Finished, resuming normal use.")
+ return discover_satellite(cli, timeout=20)

0 comments on commit bb96866

Please sign in to comment.
Something went wrong with that request. Please try again.