Skip to main content
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

```python
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:

```python
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][1]
file.

[1]: https://github.com/BlueDragonX/clank/blob/master/LICENSE "LICENSE"

Metadata

Release files for clank 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for clank 0.1.2
File Size Uploaded
clank-0.1.2.tar.gz 5.1 kB Details

Release files / clank-0.1.2.tar.gz

Download URL clank-0.1.2.tar.gz
Size 5.1 kB
Tags Source
SHA-256 checksum
How to use checksums
45d896ee2aa6dc094859f5371745d7819b0663c359179d0ce51607d472a61d7e
BLAKE2b-256 checksum
How to use checksums
659fbc22223c3c245ce9ca1658996e610621343b9529267c4940a26dcf2c150d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.2 This release

1 release file

v0.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page