From 552c02561e8e79b9b2e658453f269fba68fab9a5 Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Sun, 26 Feb 2017 17:19:15 -0500 Subject: Changes to make our project as welcoming as possible for new contributors. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Changes include: 1) Added CONTRIBUTING.md with detailed instructions for how to contribute, which should be especially useful to those new to open source in general or GitHub in particular 2) Added CODE_OF_CONDUCT.md which sets ground rules for participants’ behavior and helps to facilitate a friendly, welcoming environment 3) Renamed the "example" directory to "examples" in the hope that one day soon there may be more than a single example ;-) --- example/example.py | 53 ----------------------------------------------------- 1 file changed, 53 deletions(-) delete mode 100755 example/example.py (limited to 'example/example.py') diff --git a/example/example.py b/example/example.py deleted file mode 100755 index f39be5de..00000000 --- a/example/example.py +++ /dev/null @@ -1,53 +0,0 @@ -#!/usr/bin/env python -# coding=utf-8 -"""A sample application for cmd2. - -Thanks to cmd2's built-in transtript testing capability, it also serves as a test suite for example.py when used with - the exampleSession.txt transcript. - -Running `python example.py -t exampleSession.txt` will run all the commands in the transcript against example.py, -verifying that the output produced matches the transcript. -""" - -from cmd2 import Cmd, make_option, options - - -class CmdLineApp(Cmd): - """ Example cmd2 application. """ - multilineCommands = ['orate'] - Cmd.shortcuts.update({'&': 'speak'}) - maxrepeats = 3 - Cmd.settable.append('maxrepeats') - - # Setting this true makes it run a shell command if a cmd2/cmd command doesn't exist - # default_to_shell = True - - def __init__(self): - # Set use_ipython to True to enable the "ipy" command which embeds and interactive IPython shell - Cmd.__init__(self, use_ipython=False) - - @options([make_option('-p', '--piglatin', action="store_true", help="atinLay"), - make_option('-s', '--shout', action="store_true", help="N00B EMULATION MODE"), - make_option('-r', '--repeat', type="int", help="output [n] times") - ]) - def do_speak(self, arg, opts=None): - """Repeats what you tell me to.""" - arg = ''.join(arg) - if opts.piglatin: - arg = '%s%say' % (arg[1:], arg[0]) - if opts.shout: - arg = arg.upper() - repetitions = opts.repeat or 1 - for i in range(min(repetitions, self.maxrepeats)): - self.stdout.write(arg) - self.stdout.write('\n') - # self.stdout.write is better than "print", because Cmd can be - # initialized with a non-standard output destination - - do_say = do_speak # now "say" is a synonym for "speak" - do_orate = do_speak # another synonym, but this one takes multi-line input - - -if __name__ == '__main__': - c = CmdLineApp() - c.cmdloop() -- cgit v1.2.1