Permalink
Browse files

initial commit

  • Loading branch information...
0 parents commit 33c6ccc5a0ceba89a834c41bb0850fc5d339de27 @ehazlett committed May 3, 2012
Showing with 487 additions and 0 deletions.
  1. +21 −0 .gitignore
  2. +177 −0 LICENSE
  3. +2 −0 gearbox/__init__.py
  4. +67 −0 gearbox/cli.py
  5. +75 −0 gearbox/core.py
  6. +44 −0 readme.md
  7. +46 −0 setup.py
  8. +55 −0 templates.json
@@ -0,0 +1,21 @@
+*.py[co]
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
177 LICENSE
@@ -0,0 +1,177 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
@@ -0,0 +1,2 @@
+__version__ = '0.1'
+__author__ = 'Evan Hazlett <ejhazlett@gmail.com>'
@@ -0,0 +1,67 @@
+#!/usr/bin/env python
+# Copyright 2012 Gearbox Project
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from optparse import OptionParser
+import sys
+import os
+import commands
+from core import Gearbox
+import logging
+
+logging.getLogger('requests').setLevel(logging.WARN)
+
+def show_templates(templates):
+ print('\n{0:25s} {1:20s} {2:15s} {3}'.format('Name', 'Author', 'Type', 'Description'))
+ print('-----------------------------------------------------------------------------')
+ for t in templates:
+ print('{0:25s} {1:20s} {2:15s} {3}'.format(t.get('name'), t.get('author'), t.get('type'), t.get('description')))
+ print('')
+
+def main():
+ base_url = 'https://raw.github.com/ehazlett/gearbox/master'
+ log_level = logging.INFO
+ log_format = "%(levelname)-10s %(name)s %(message)s"
+
+ op = OptionParser()
+ op.add_option('-n', '--name', dest='name', help='Name of application')
+ op.add_option('-t', '--template', dest='template', help='Name of application template')
+ op.add_option('-l', '--list-templates', dest='list_templates', action='store_true', default=False, help='List available app templates')
+ op.add_option('-d', '--debug', dest='debug', action='store_true', default=False, help='Run debug mode')
+
+ opts, args = op.parse_args()
+ # check for rhc client
+ if not commands.getoutput('which rhc'):
+ print('Unable to find OpenShift rhc client. Please install before using Gearbox.')
+ sys.exit(1)
+ template_file = None
+ if opts.debug:
+ tmpl_file = os.path.join(os.getcwd(), 'templates.json')
+ if os.path.exists(tmpl_file):
+ template_file = tmpl_file
+ log_level = logging.DEBUG
+ gb = Gearbox(base_url, debug=opts.debug, template_file=template_file)
+ # configure logging
+ logging.basicConfig(format=log_format, level=log_level)
+ if opts.list_templates:
+ show_templates(gb.list_templates())
+ sys.exit(0)
+ if opts.name and opts.template:
+ if gb.create_app(name=opts.name, template=opts.template):
+ print('Your application should be available at {0}-<domain>.rhcloud.com'.format(opts.name))
+ sys.exit(0)
+ op.print_help()
+
+if __name__=='__main__':
+ main()
+
@@ -0,0 +1,75 @@
+#!/usr/bin/env python
+# Copyright 2012 Gearbox Project
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import requests
+from subprocess import Popen, PIPE
+import logging
+try:
+ import simplejson as json
+except ImportError:
+ import json
+
+class Gearbox(object):
+ """docstring for Gearbox"""
+ def __init__(self, base_url='https://raw.github.com/vitasso/gearbox/master', \
+ template_file=None, debug=False):
+ self._base_url = base_url
+ self._template_file = template_file
+ if not template_file:
+ self._template_file = '{0}/templates.json'.format(self._base_url)
+ self._debug = debug
+ self._log = logging.getLogger(__name__)
+
+ def list_templates(self):
+ """
+ Gets a list of Gearbox templates
+
+ :rtype: List of templates
+
+ """
+ if self._debug:
+ templates = json.loads(open(self._template_file, 'r').read())
+ else:
+ r = requests.get(self._template_file)
+ templates = json.loads(r.text)
+ return templates
+
+ def create_app(self, name=None, template=None):
+ templates = self.list_templates()
+ tmpls = [x for x in templates if x.get('name') == template]
+ if tmpls:
+ template = tmpls[0]
+ else:
+ raise NameError('{0} is not a valid template'.format(template))
+ self._log.debug('Creating application')
+ # create app
+ cmd = 'rhc-create-app -a {0} -t {1}'.format(name, template.get('type'))
+ p = Popen([cmd], shell=True)
+ p.wait()
+ # check for cartridges
+ for c in template.get('cartridges'):
+ self._log.debug('Adding cartridge {0}'.format(c))
+ cmd = 'rhc app cartridge add -a {0} -c {1}'.format(name, c)
+ p = Popen([cmd], shell=True)
+ p.wait()
+ # get and push app
+ self._log.debug('Adding upstream')
+ cmd = 'cd {0} ; git remote add upstream -m master {1}'.format(name, template.get('repo'))
+ p = Popen([cmd], shell=True)
+ p.wait()
+ self._log.debug('Pulling from upstream and pushing to OpenShift')
+ cmd = 'cd {0} ; git pull -s recursive -X theirs upstream master ; git push'.format(name)
+ p = Popen([cmd], shell=True)
+ p.wait()
+ return True
@@ -0,0 +1,44 @@
+Gearbox
+=========
+Gearbox is a tool for bootstrapping [OpenShift](http://openshift.redhat.com) pre-built applications. With gearbox you can view a list of template applications such as Django, Drupal, and many more (run `gb -l` for a complete list).
+
+Installation
+=============
+Gearbox is written in Python. Run `pip install gearbox`.
+
+Usage
+======
+
+List Templates
+---------------
+To list available application templates run:
+
+`gb -l`
+
+```
+Name Author Type Description
+-----------------------------------------------------------------------------
+django openshift python-2.6 Default latest stable version of Django
+drupal openshift php-5.3 Example install of Drupal
+sugarcrm openshift php-5.3 Example install of SugarCRM
+.......
+
+```
+
+Create Application
+-------------------
+To create an application:
+
+`gb -n mydjango -t django`
+
+This will create a new OpenShift application named `mydjango`, create any OpenShift cartridges needed by the app, clone set the upstream repo to the sample, pull in the changes, and finally push and deploy the app to OpenShift.
+
+
+Thanks
+=======
+Many thanks to the OpenShift team for all of the great work on the product -- and especially for open sourcing it :)
+
+Help & contributing
+====================
+If you need help, you can find me on IRC (`ehazlett` on freenode) or shoot me a message here. Pull-requests also welcome :)
+
Oops, something went wrong.

0 comments on commit 33c6ccc

Please sign in to comment.