Giter VIP home page Giter VIP logo

clank's Introduction

Clank

A library to quickly build monolithic commandline tools.

Standard Example

This creates a tool with a hello command which prints "Hello, world!":

from clank import Command, HelpCommand, Manager, UsageCommand

class HelloCommand(Command):
    """Say hello."""
    name = 'hello'

    def run(self, args):
        print("Hello, world!")

if __name__ == '__main__':
    Manager([HelloCommand, HelpCommand, UsageCommand]).run()

Argument Example

The ArgumentCommand class uses argparse to parse commandline arguments. This code reimplments the HelloCommand class to accept a name as an option:

from clank import ArgumentCommand, HelpCommand, Manager, UsageCommand

class HelloCommand(ArgumentCommand):
    """Say hello."""
    name = 'hello'

    def add_arguments(self):
        self.argparser.add_argument(
            '-n', '--name', dest='name', nargs=1, default='world',
            help="The name to run the app in.")

    def run(self, args):
        self.parse_args(args)
        print("Hello, {}!".format(self.options.name))

if __name__ == '__main__':
    Manager([HelloCommand, HelpCommand, UsageCommand]).run()

License

Copyright (c) 2014 Ryan Bourgeois. This project and all of its contents is licensed under the BSD-derived license as found in the included LICENSE file.

clank's People

Contributors

rynbrd avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

tryweirder

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.