quickie-runner 0.1.0__tar.gz

quickie_runner-0.1.0/.editorconfig

@@ -0,0 +1,27 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,rst,ini}]
+indent_style = space
+indent_size = 4
+
+[*.{html,css,scss,json,yml,xml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab
+
+[nginx.conf]
+indent_style = space
+indent_size = 2

quickie_runner-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+
+quickie.code-workspace
+
+.coverage
+.DS_Store
+htmlcov/
+
+## Python ##
+# Byte-compiled / optimized / DLL files
+__pycache__/
+
+### VisualStudioCode ###
+.vscode/*
+/build
+/dist
+*.egg-info

quickie_runner-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+default_stages: [commit]
+
+default_language_version:
+  python: python3.12 # Change if we upgrade python
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-json
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+      - id: debug-statements
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: detect-private-key
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+      - id: pyupgrade
+        args: [--py312-plus] # Change if we upgrade python
+        exclude: hooks/
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        # Fixes compatibility issues with black
+        args: [--profile=black]
+
+  - repo: https://github.com/psf/black
+    rev: 23.12.1
+    hooks:
+      - id: black
+
+ci:
+  autoupdate_schedule: weekly
+  skip: []
+  submodules: false

quickie_runner-0.1.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Quickie Change Log
+
+## Release 0.1.0
+
+- Initial release.

quickie_runner-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright 2024 Adrian Martinez Rodriguez <adrianmrit@gmail.com>
+
+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.

quickie_runner-0.1.0/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.3
+Name: quickie-runner
+Version: 0.1.0
+Summary: A CLI tool for quick tasks.
+Project-URL: Homepage, https://github.com/adrianmrit/quickie
+Project-URL: Repository, https://github.com/adrianmrit/quickie.git
+Project-URL: Issues, https://github.com/adrianmrit/quickie/issues
+Project-URL: Changelog, https://github.com/adrianmrit/quickie/blob/main/CHANGELOG.md
+Author-email: Author Name <author@example.com>
+License: The MIT License
+        
+        Copyright 2024 Adrian Martinez Rodriguez <adrianmrit@gmail.com>
+        
+        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.
+License-File: LICENSE
+Keywords: CLI,quick,tasks
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Requires-Dist: argcomplete~=3.5.0
+Requires-Dist: classoptions~=0.2.0
+Requires-Dist: frozendict~=2.4.4
+Requires-Dist: oslex~=0.1.3
+Requires-Dist: python-dotenv~=1.0.1
+Requires-Dist: rich~=13.7.1
+Provides-Extra: dev
+Requires-Dist: mock; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-mock; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Quickie - A CLI tool for quick tasks
+
+[![License](https://img.shields.io/github/license/adrianmrit/quickie)](https://github.com/adrianmrit/quickie/blob/master/LICENSE)
+
+## Getting Started
+
+### Prerequisites
+
+Some prerequisites need to be installed.
+
+- Python 3.12+
+
+### Installing
+
+The recommended way to install `quickie` is via `pipx`.
+
+With `pipx` you can add the `qck` command and the package in an isolated environment, without polluting your global Python environment.
+
+See the [pipx installation instructions](https://pipx.pypa.io/stable/installation/)
+
+After installing `pipx`, you can install `quickie` with the following command:
+
+```sh
+pipx install quickie-runner
+```
+
+You can also install `quickie` with `pip`:
+
+```sh
+pip install quickie-runner
+```
+
+## Tab completion
+
+Tab completion is available for bash and zsh. It depends on the `argcomplete` package, which should have been installed with `quickie`.
+
+To enable tab completion for `quickie`, add the following line to your `.bashrc` or `.zshrc`:
+
+```sh
+eval "$(register-python-argcomplete qck)"
+```
+
+If you get the following error in the zsh shell:
+
+```sh
+complete:13: command not found: compdef
+```
+
+You can fix it by adding the following line to your `.zshrc` (before the line that registers the completion):
+
+```sh
+autoload -Uz compinit && compinit
+```
+
+## Usage
+
+Tasks are configured under a `__quickie.py` or `__quickie` python module in the current directory.
+If using a `__quickie` directory, the tasks are defined in the `__quickie/__init__.py` file.
+
+Tasks are defined as classes, though factory functions are also supported.
+
+### Why define tasks in Python?
+
+While many existing similar tools use YAML, TOML or custom formats to define tasks, `quickie` uses Python for the following reasons:
+
+- Built-in syntax highlighting and linting
+- Supported by most editors and IDEs
+- Easy to use and understand
+- Extensible and powerful
+
+### Quick Example
+
+Here is a simple example of a `__quickie.py` file:
+
+```python
+from quickie.tasks import Task, ScriptTask
+
+class hello(Task):
+    def run(self):
+        print("Hello, world!")
+
+
+class ScriptTaskExample(ScriptTask):
+    class Meta:
+        alias = "echo"
+        allow_unknown_args = True
+
+    def get_script(self, *args):
+        return " ".join(["echo", *args])
+```
+
+You can run the `Hello` task with the following command:
+
+```sh
+qck hello
+```
+
+And the `ScriptTaskExample` task with:
+
+```sh
+qck echo "Hello, world!"
+```

quickie_runner-0.1.0/README.md

@@ -0,0 +1,102 @@
+# Quickie - A CLI tool for quick tasks
+
+[![License](https://img.shields.io/github/license/adrianmrit/quickie)](https://github.com/adrianmrit/quickie/blob/master/LICENSE)
+
+## Getting Started
+
+### Prerequisites
+
+Some prerequisites need to be installed.
+
+- Python 3.12+
+
+### Installing
+
+The recommended way to install `quickie` is via `pipx`.
+
+With `pipx` you can add the `qck` command and the package in an isolated environment, without polluting your global Python environment.
+
+See the [pipx installation instructions](https://pipx.pypa.io/stable/installation/)
+
+After installing `pipx`, you can install `quickie` with the following command:
+
+```sh
+pipx install quickie-runner
+```
+
+You can also install `quickie` with `pip`:
+
+```sh
+pip install quickie-runner
+```
+
+## Tab completion
+
+Tab completion is available for bash and zsh. It depends on the `argcomplete` package, which should have been installed with `quickie`.
+
+To enable tab completion for `quickie`, add the following line to your `.bashrc` or `.zshrc`:
+
+```sh
+eval "$(register-python-argcomplete qck)"
+```
+
+If you get the following error in the zsh shell:
+
+```sh
+complete:13: command not found: compdef
+```
+
+You can fix it by adding the following line to your `.zshrc` (before the line that registers the completion):
+
+```sh
+autoload -Uz compinit && compinit
+```
+
+## Usage
+
+Tasks are configured under a `__quickie.py` or `__quickie` python module in the current directory.
+If using a `__quickie` directory, the tasks are defined in the `__quickie/__init__.py` file.
+
+Tasks are defined as classes, though factory functions are also supported.
+
+### Why define tasks in Python?
+
+While many existing similar tools use YAML, TOML or custom formats to define tasks, `quickie` uses Python for the following reasons:
+
+- Built-in syntax highlighting and linting
+- Supported by most editors and IDEs
+- Easy to use and understand
+- Extensible and powerful
+
+### Quick Example
+
+Here is a simple example of a `__quickie.py` file:
+
+```python
+from quickie.tasks import Task, ScriptTask
+
+class hello(Task):
+    def run(self):
+        print("Hello, world!")
+
+
+class ScriptTaskExample(ScriptTask):
+    class Meta:
+        alias = "echo"
+        allow_unknown_args = True
+
+    def get_script(self, *args):
+        return " ".join(["echo", *args])
+```
+
+You can run the `Hello` task with the following command:
+
+```sh
+qck hello
+```
+
+And the `ScriptTaskExample` task with:
+
+```sh
+qck echo "Hello, world!"
+```

quickie_runner-0.1.0/pyproject.toml

@@ -0,0 +1,91 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "quickie-runner"
+dynamic = ["version"]
+description = "A CLI tool for quick tasks."
+readme = "README.md"
+authors = [
+    { name = "Author Name", email = "author@example.com" }
+]
+license = { file = "LICENSE" }
+# url = { "Homepage" = "https://example.com" }
+keywords = ["CLI", "quick", "tasks"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License",
+]
+requires-python = ">=3.12"
+dependencies=[
+    "classoptions~=0.2.0",
+    "frozendict~=2.4.4",
+    "oslex~=0.1.3",
+    "python-dotenv~=1.0.1",
+    "rich~=13.7.1",
+    "argcomplete~=3.5.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/adrianmrit/quickie"
+Repository = "https://github.com/adrianmrit/quickie.git"
+Issues = "https://github.com/adrianmrit/quickie/issues"
+Changelog = "https://github.com/adrianmrit/quickie/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+dev = [
+    "mock",
+    "pytest",
+    "pytest-cov",
+    "pytest-mock"
+]
+
+[project.scripts]
+"qck" = "quickie.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/quickie"]
+
+[tool.hatch.version]
+path = "src/quickie/_meta.py"
+
+[tool.hatch.build]
+exclude = ["__quickie"]
+
+[tool.pytest.ini_options]
+addopts = ["-vv"]
+markers = [
+    "unit",
+    "integration"
+]
+python_files = "tests/*.py"
+mock_use_standalone_module = true
+
+[tool.coverage.run]
+source = ["src/quickie"]
+omit = [
+    "tests/*",
+    "__quickie/*"
+]
+
+[tool.ruff]
+
+[tool.ruff.lint]
+select = [
+    "PL",  # pylint
+    "E",   # pycodestyle
+    "F",   # pyflakes
+    "D",   # pydocstyle
+]
+fixable = ["ALL"]
+ignore = ["D106"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["D"]

quickie_runner-0.1.0/src/quickie/__init__.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+# PYTHON_ARGCOMPLETE_OK
+"""A CLI tool for quick tasks."""
+from ._meta import __author__, __copyright__, __email__, __home__, __version__
+
+__all__ = [
+    "__author__",
+    "__copyright__",
+    "__email__",
+    "__home__",
+    "__version__",
+]

quickie_runner-0.1.0/src/quickie/__main__.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+# PYTHON_ARGCOMPLETE_OK
+"""Entry point for the application script."""
+
+
+import sys
+
+from .cli import main
+
+
+def _run_main():
+    if __name__ == "__main__":
+        argv = sys.argv[1:]
+        main(argv)
+
+
+_run_main()

quickie_runner-0.1.0/src/quickie/_meta.py

@@ -0,0 +1,7 @@
+"""Metadata for the package."""
+
+__version__ = "0.1.0"
+__author__ = "Adrian Martinez Rodriguez"
+__email__ = "adrianmrit@gmail.com"
+__home__ = "https://github.com/adrianmrit/quickie"
+__copyright__ = "Copyright (C) 2024 " + __author__

quickie_runner-0.1.0/src/quickie/_version.py

@@ -0,0 +1,5 @@
+"""Read the version from installed package data."""
+
+from _meta import __version__
+
+__all__ = ["__version__"]

quickie_runner-0.1.0/src/quickie/argparser.py

@@ -0,0 +1,73 @@
+"""Custom argument parser for quickie."""
+
+import typing
+from argparse import ArgumentParser
+
+import argcomplete
+
+from quickie._meta import __version__ as version
+from quickie.completion._internal import TaskCompleter
+
+
+class ArgumentsParser(ArgumentParser):
+    """Custom argument parser for quickie."""
+
+    @typing.override
+    def __init__(self, main):
+        super().__init__(description="A CLI tool for quick tasks.")
+        module_or_global_group = self.add_mutually_exclusive_group()
+        self.add_argument("-V", "--version", action="version", version=version)
+        self.add_argument("-l", "--list", action="store_true", help="List tasks")
+        module_or_global_group.add_argument(
+            "-m", "--module", type=str, help="The module to load tasks from"
+        )
+        module_or_global_group.add_argument(
+            "-g",
+            "--global",
+            action="store_true",
+            help="Use global defined tasks",
+            dest="use_global",
+        )
+        module_or_global_group.add_argument(
+            "--autocomplete",
+            help="Suggest autocompletion for the shell",
+            dest="suggest_auto_completion",
+            choices=["bash", "zsh"],
+        ).completer = argcomplete.ChoicesCompleter(["bash", "zsh"])
+        self.add_argument(
+            "task", nargs="?", help="The task to run"
+        ).completer = TaskCompleter(main)
+        # This does not need completion as it is handled by the task completer
+        self.add_argument("args", nargs="*", help="The arguments to pass to the task")
+
+    @typing.override
+    def parse_known_args(self, args=None, namespace=None):
+        qck_args, task_args = self._partition_args(args)
+        namespace, argv = super().parse_known_args(qck_args, namespace)
+
+        if argv:
+            # Because the unknown arguments are not task arguments, we raise an error
+            msg = "unrecognized arguments: %s"
+            self.error(msg % " ".join(argv))
+
+        # namespace.task = task
+        namespace.args = task_args
+        return namespace, []
+
+    def _partition_args(self, args):
+        qck_args = []
+        task_args = []
+        args = iter(args)
+        while arg := next(args, None):
+            if arg in {"-m", "--module", "--autocomplete"}:
+                qck_args.append(arg)
+                qck_args.append(next(args))
+            elif arg.startswith("-"):
+                qck_args.append(arg)
+            else:
+                # Task found
+                qck_args.append(arg)
+                # The rest of the arguments are task arguments
+                task_args = list(args)
+
+        return qck_args, task_args