Run

Run is a program to run tasks from files.

Example

The real simple example introduces some functionality.

• create runfile.py in current working directory:

  from run import Module, require, trigger
  
  class Module(Module):
  
      #Tasks
  
      def ready(self):
          print('We are ready.')
  
      @require('ready')
      @trigger('done')
      def hello(self, person='World', times=3):
          """Say hello to the given person."""
          print('Hello', person, str(times), 'times!')
  
      def done(self):
          print('We are done.')

• get run attributes list from command line:

  $ run
  default
  done
  hello
  info
  list
  meta
  ready
  [+] list
  [+]

• autocomplete attribute from command line:

  $ run h<TAB>
  $ run hello

• get attribute infomation from command line:

  $ run hello -i
  hello(person='World', times=3)
  ---
  Type: MethodTask
  Dependencies: [trigger <MethodTask "done">, require <MethodTask "ready">]
  Default arguments: ()
  Default keyword arguments: {}
  ---
  Say hello to the given person.
  [+] info

• run task from command line:

  $ run hello Rachel, times=5
  We are ready.
  [+] hello/ready
  Hello Rachel 5 times!
  We are done.
  [+] hello/done
  [+] hello

Requirements

• Platforms
  • Unix
• Interpreters
  • Python 3.3
  • Python 3.4

Installation

• pip3 install runfile

Contribution

• Authors
  • roll <roll@respect31.com>
• Maintainers
  • roll <roll@respect31.com>

Stability

Package's public API follows semver versioning model:

• DEVELOP: 0.X[Breaking changes][API changes].X[Minor changes]
• PRODUCT: X[Breaking changes].X[API changes].X[Minor changes]

Be careful on DEVELOP stage package is under active development and can be drastically changed or even deleted. Don't use package in production before PRODUCT stage is reached.

For the more information see package's changelog.

License

MIT License

© Copyright 2015, Inventive Ninja.

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.