Browse files

initial commit

  • Loading branch information...
1 parent ba16f3c commit d23ebb8f5ce917344bf1a72cfd3e537c954514b8 @dcramer committed Feb 15, 2012
Showing with 419 additions and 3 deletions.
  1. +4 −0 .gitignore
  2. +202 −0 LICENSE
  3. +3 −3 README.rst
  4. +7 −0 logan/
  5. +127 −0 logan/
  6. +52 −0 logan/
  7. +24 −0
@@ -0,0 +1,4 @@
@@ -0,0 +1,202 @@
+ Apache License
+ Version 2.0, January 2004
+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,
+ implied, including, without limitation, any warranties or conditions
+ 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.
+APPENDIX: How to apply the Apache License to your work.
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+Copyright 2012 David Cramer
+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
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+See the License for the specific language governing permissions and
+limitations under the License.
@@ -13,7 +13,7 @@ for running the application::
'console_scripts': [
- 'sentry = logan.runner:main',
+ 'sentry = logan.runner:run_app',
@@ -32,7 +32,7 @@ as well as a template to generate for the user if their configuration does not e
To do this, within our sentry project we create a simple script, lets call put it in ``sentry/``::
- from logan.runner import run_configured
+ from logan.runner import run_app
def generate_settings():
@@ -43,7 +43,7 @@ To do this, within our sentry project we create a simple script, lets call put i
return ""
def main():
- run_configured(
+ run_app(
@@ -0,0 +1,7 @@
+:copyright: (c) 2012 David Cramer.
+:license: Apache License 2.0, see LICENSE for more details.
@@ -0,0 +1,127 @@
+:copyright: (c) 2012 David Cramer.
+:license: Apache License 2.0, see LICENSE for more details.
+from __future__ import absolute_import
+from django.core import management
+from optparse import OptionParser
+import os
+import re
+import sys
+from logan.settings import create_default_settings, load_settings
+def sanitize_name(project):
+ project = project.replace(' ', '-')
+ return re.sub('[^A-Z0-9a-z_-]', '-', project)
+def parse_args(args):
+ """
+ This parses the arguments and returns a tuple containing:
+ (args, command, command_args)
+ For example, "--config=bar start --with=baz" would return:
+ (['--config=bar'], 'start', ['--with=baz'])
+ """
+ index = None
+ for arg_i, arg in enumerate(args):
+ if not arg.startswith('-'):
+ index = arg_i
+ break
+ # Unable to parse any arguments
+ if index is None:
+ return (args, None, None)
+ return (args[:index], args[index], args[(index + 1):])
+def run_app(project=None, default_config_path=None, default_settings=None,
+ settings_initializer=None, settings_envvar=None):
+ """
+ :param project: should represent the canonical name for the project, generally
+ the same name it assigned in distutils.
+ :param default_config_path: the default location for the configuration file.
+ :param default_settings: default settings to load (think inheritence).
+ :param settings_initializer: a callback function which should return a string
+ representing the default settings template to generate.
+ """
+ sys_args = sys.argv
+ # The established command for running this program
+ runner_name = sys_args[0]
+ args, command, command_args = parse_args(sys_args[1:])
+ if not command:
+ print "usage: %s [--config=/path/to/] [command] [options]" % runner_name
+ parser = OptionParser()
+ project_filename = sanitize_name(project)
+ if default_config_path is None:
+ default_config_path = '~/%s/' % (project_filename, project_filename)
+ if settings_envvar is None:
+ settings_envvar = project_filename.upper()
+ # normalize path
+ if settings_envvar in os.environ:
+ default_config_path = os.environ.get(settings_envvar)
+ else:
+ default_config_path = os.path.normpath(os.path.abspath(os.path.expanduser(default_config_path)))
+ # The ``init`` command is reserved for initializing configuration
+ if command == 'init':
+ (options, opt_args) = parser.parse_args()
+ config_path = ' '.join(opt_args[1:]) or default_config_path
+ if os.path.exists(config_path):
+ resp = None
+ while resp not in ('Y', 'n'):
+ resp = raw_input('File already exists at %r, overwrite? [nY] ' % config_path)
+ if resp == 'n':
+ print "Aborted!"
+ return
+ try:
+ create_default_settings(config_path, settings_initializer)
+ except OSError, e:
+ raise e.__class__, 'Unable to write default settings file to %r' % config_path
+ print "Configuration file created at %r" % config_path
+ return
+ parser.add_option('--config', metavar='CONFIG', default=default_config_path)
+ (options, logan_args) = parser.parse_args()
+ config_path = options.config
+ if not os.path.exists(config_path):
+ raise ValueError("Configuration file does not exist. Use '%s init' to initialize the file." % runner_name)
+ if default_settings:
+ management.setup_environ(default_settings)
+ load_settings(config_path)
+ management.execute_from_command_line([runner_name, command] + command_args)
+ sys.exit(0)
+if __name__ == '__main__':
+ run_app()
Oops, something went wrong.

0 comments on commit d23ebb8

Please sign in to comment.