fastcommand 0.1.6__tar.gz

fastcommand-0.1.6/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2024 Jason Morley
+
+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.

fastcommand-0.1.6/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.1
+Name: fastcommand
+Version: 0.1.6
+Author-email: Jason Morley <hello@jbmorley.co.uk>
+License: MIT License
+        
+        Copyright (c) 2021-2024 Jason Morley
+        
+        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.
+        
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# fastcommand
+
+Python module for defining multi-command cli programs
+
+## Description
+
+The `fastcommand` module is a lightweight wrapper over `argparse` which aims to make it easier to write multi-command cli programs and utilities. It does so by providing convenience decorators that allow for quickly defining sub-commands.
+
+## Usage
+
+```python
+import fastcommand
+
+
+@fastcommand.command("hello", help="say hello")
+def command_hello(options):
+    print("Hello, World!")
+
+
+def main():
+    cli = fastcommand.CommandParser(description="Simple fastcommand example.")
+    cli.use_logging(format="[%(levelname)s] %(message)s")
+    cli.run()
+
+
+if __name__ == "__main__":
+    main()
+```

fastcommand-0.1.6/README.md

@@ -0,0 +1,28 @@
+# fastcommand
+
+Python module for defining multi-command cli programs
+
+## Description
+
+The `fastcommand` module is a lightweight wrapper over `argparse` which aims to make it easier to write multi-command cli programs and utilities. It does so by providing convenience decorators that allow for quickly defining sub-commands.
+
+## Usage
+
+```python
+import fastcommand
+
+
+@fastcommand.command("hello", help="say hello")
+def command_hello(options):
+    print("Hello, World!")
+
+
+def main():
+    cli = fastcommand.CommandParser(description="Simple fastcommand example.")
+    cli.use_logging(format="[%(levelname)s] %(message)s")
+    cli.run()
+
+
+if __name__ == "__main__":
+    main()
+```

fastcommand-0.1.6/fastcommand/__init__.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python3
+
+# Copyright (c) 2021-2024 Jason Morley
+#
+# 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.
+
+from .main import *

fastcommand-0.1.6/fastcommand/main.py

@@ -0,0 +1,90 @@
+#!/usr/bin/env python3
+
+# Copyright (c) 2021-2024 Jason Morley
+#
+# 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.
+
+import argparse
+import functools
+import logging
+import sys
+
+
+COMMANDS = {}
+
+
+class Command(object):
+
+    def __init__(self, name, help, arguments, epilog, formatter_class, callback):
+        self.name = name
+        self.help = help
+        self.arguments = arguments
+        self.epilog = epilog
+        self.formatter_class = formatter_class
+        self.callback = callback
+
+class Argument(object):
+
+    def __init__(self, *args, **kwargs):
+        self.args = args
+        self.kwargs = kwargs
+
+
+def command(name, help="", arguments=[], epilog=None, formatter_class=argparse.HelpFormatter):
+    def wrapper(fn):
+        @functools.wraps(fn)
+        def inner(*args, **kwargs):
+            return fn(*args, **kwargs)
+        COMMANDS[name] = Command(name, help, arguments, epilog, formatter_class, inner)
+        return inner
+    return wrapper
+
+
+class CommandParser(object):
+
+    def __init__(self, *args, **kwargs):
+        self.parser = argparse.ArgumentParser(*args, **kwargs)
+        subparsers = self.parser.add_subparsers(help="command")
+        for name, command in COMMANDS.items():
+            subparser = subparsers.add_parser(command.name,
+                                              help=command.help,
+                                              epilog=command.epilog,
+                                              formatter_class=command.formatter_class)
+            for argument in command.arguments:
+                subparser.add_argument(*(argument.args), **(argument.kwargs))
+            subparser.set_defaults(fn=command.callback)
+
+    def add_argument(self, *args, **kwargs):
+        self.parser.add_argument(*args, **kwargs)
+
+    def use_logging(self, format):
+        verbose = '--verbose' in sys.argv[1:] or '-v' in sys.argv[1:]
+        logging.basicConfig(level=logging.DEBUG if verbose else logging.INFO,
+                            format="[%(levelname)s] %(message)s")
+        self.parser.add_argument('--verbose', '-v',
+                                 action='store_true',
+                                 default=False,
+                                 help="show verbose output")
+
+    def run(self):
+        options = self.parser.parse_args()
+        if 'fn' not in options:
+            logging.error("No command specified.")
+            exit(1)
+        options.fn(options)

fastcommand-0.1.6/fastcommand.egg-info/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.1
+Name: fastcommand
+Version: 0.1.6
+Author-email: Jason Morley <hello@jbmorley.co.uk>
+License: MIT License
+        
+        Copyright (c) 2021-2024 Jason Morley
+        
+        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.
+        
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# fastcommand
+
+Python module for defining multi-command cli programs
+
+## Description
+
+The `fastcommand` module is a lightweight wrapper over `argparse` which aims to make it easier to write multi-command cli programs and utilities. It does so by providing convenience decorators that allow for quickly defining sub-commands.
+
+## Usage
+
+```python
+import fastcommand
+
+
+@fastcommand.command("hello", help="say hello")
+def command_hello(options):
+    print("Hello, World!")
+
+
+def main():
+    cli = fastcommand.CommandParser(description="Simple fastcommand example.")
+    cli.use_logging(format="[%(levelname)s] %(message)s")
+    cli.run()
+
+
+if __name__ == "__main__":
+    main()
+```

fastcommand-0.1.6/fastcommand.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+fastcommand/__init__.py
+fastcommand/main.py
+fastcommand.egg-info/PKG-INFO
+fastcommand.egg-info/SOURCES.txt
+fastcommand.egg-info/dependency_links.txt
+fastcommand.egg-info/top_level.txt

fastcommand-0.1.6/fastcommand.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fastcommand-0.1.6/fastcommand.egg-info/top_level.txt

@@ -0,0 +1 @@
+fastcommand

fastcommand-0.1.6/pyproject.toml

@@ -0,0 +1,13 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta:__legacy__"
+
+[project]
+name = "fastcommand"
+readme = "README.md"
+license = {file = "LICENSE"}
+authors = [
+  {name = "Jason Morley", email = "hello@jbmorley.co.uk"}
+]
+dependencies = []
+dynamic = ["version"]

fastcommand-0.1.6/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fastcommand-0.1.6/setup.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+
+# Copyright (c) 2021-2024 Jason Morley
+#
+# 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.
+
+import os
+
+from setuptools import setup
+
+
+setup(version=os.environ["VERSION"] if "VERSION" in os.environ else "0.0.0")