pyqwe 0.1.0__tar.gz

pyqwe-0.1.0/.gitignore

@@ -0,0 +1,68 @@
+.idea/
+
+ # Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+/venv/

pyqwe-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 David Carmichael
+
+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.

pyqwe-0.1.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.1
+Name: pyqwe
+Version: 0.1.0
+Summary: Run commands set in the pyproject.toml file
+Author-email: David Carmichael <david@uilix.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Project-URL: Source, https://github.com/CheeseCake87/qwe
+
+# 🏎️💨 pyqwe
+
+The Quick Work Environment for Python.
+
+Run commands quickly from the pyproject.toml file.
+
+`pip install pyqwe`
+
+## Usage
+
+Add commands to the pyproject.toml file.
+
+```toml
+[tool.pyqwe]
+flask = "flask_app:run"
+say_hello = "*cmd:echo Hello World"
+```
+
+### Python commands:
+
+For Python, the commands are structured like (package:module):function
+
+#### Package example:
+
+```text
+project/
+    flask_app/
+        __init__.py
+```
+
+The following command will run the function
+`run` from the `__init__.py` file in the `flask_app` package.
+
+`flask = "flask_app:run"`
+
+#### Module example:
+
+```text
+project/
+    app.py
+```
+
+The following command will run the function
+`run` from the `app.py` file.
+
+`flask = "app:run"`
+
+Now run the qwe command:
+
+`qwe flask`
+
+and this will start the Flask app.
+
+### CMD labeled commands:
+
+And command that is labeled with `*cmd` will be ran using subprocess.
+
+`say_hello = "*cmd:echo Hello World"`
+
+Now run the qwe command:
+
+`qwe say_hello`
+
+and this will print `Hello World`.
+
+#### Run as shell
+
+To run the command as a subprocess shell command, add the `shell` key to the command.
+
+`say_hello = "*cmd-shell:echo Hello World"`
+
+### Other commands
+
+`-h` or `--help` will display all the commands set in the pyproject.toml file.
+`__version__` will display the version of qwe.
+

pyqwe-0.1.0/README.md

@@ -0,0 +1,75 @@
+# 🏎️💨 pyqwe
+
+The Quick Work Environment for Python.
+
+Run commands quickly from the pyproject.toml file.
+
+`pip install pyqwe`
+
+## Usage
+
+Add commands to the pyproject.toml file.
+
+```toml
+[tool.pyqwe]
+flask = "flask_app:run"
+say_hello = "*cmd:echo Hello World"
+```
+
+### Python commands:
+
+For Python, the commands are structured like (package:module):function
+
+#### Package example:
+
+```text
+project/
+    flask_app/
+        __init__.py
+```
+
+The following command will run the function
+`run` from the `__init__.py` file in the `flask_app` package.
+
+`flask = "flask_app:run"`
+
+#### Module example:
+
+```text
+project/
+    app.py
+```
+
+The following command will run the function
+`run` from the `app.py` file.
+
+`flask = "app:run"`
+
+Now run the qwe command:
+
+`qwe flask`
+
+and this will start the Flask app.
+
+### CMD labeled commands:
+
+And command that is labeled with `*cmd` will be ran using subprocess.
+
+`say_hello = "*cmd:echo Hello World"`
+
+Now run the qwe command:
+
+`qwe say_hello`
+
+and this will print `Hello World`.
+
+#### Run as shell
+
+To run the command as a subprocess shell command, add the `shell` key to the command.
+
+`say_hello = "*cmd-shell:echo Hello World"`
+
+### Other commands
+
+`-h` or `--help` will display all the commands set in the pyproject.toml file.
+`__version__` will display the version of qwe.

pyqwe-0.1.0/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "pyqwe"
+description = 'Run commands set in the pyproject.toml file'
+authors = [{ name = "David Carmichael", email = "david@uilix.com" }]
+readme = "README.md"
+requires-python = ">=3.11"
+license = { file = "LICENSE" }
+classifiers = ["License :: OSI Approved :: MIT License"]
+dynamic = ["version"]
+
+[project.scripts]
+pyqwe = "pyqwe:main"
+
+[project.urls]
+Source = "https://github.com/CheeseCake87/qwe"

pyqwe-0.1.0/pyqwe/__init__.py

@@ -0,0 +1,105 @@
+import argparse
+import importlib
+import importlib.util
+import shlex
+import subprocess
+import sys
+import tomllib
+from pathlib import Path
+
+__version__ = "0.1.0"
+
+
+class NotAPythonPackageError(Exception):
+    pass
+
+
+def _no_traceback_eh(exc_type, exc_val, traceback):
+    pass
+
+
+_cwd = Path().cwd()
+_pyproject_file = _cwd / "pyproject.toml"
+
+if not _pyproject_file.exists():
+    raise FileNotFoundError("pyproject.toml not found")
+
+_pyproject = tomllib.loads(_pyproject_file.read_text())
+_qwe = _pyproject.get("tool", {}).get("pyqwe")
+
+if not _qwe or not isinstance(_qwe, dict):
+    raise ValueError("tool.qwe not found in pyproject.toml")
+
+
+def _split_runner(runner_: str) -> tuple:
+    r = runner_.split(":")
+    sr = r[0]  # start or runner
+    er = r[1].lower()  # end of runner
+    return sr, er
+
+
+def _path_to_module(path: Path) -> str:
+    file = path.stem
+    path = path.parent
+    return f"{path.name}.{file}"
+
+
+def _run(sr: str, er: str):
+    try:
+
+        if "*" in sr:
+            if "cmd" in sr:
+                if "shell" in sr:
+                    subprocess.run(er, shell=True)
+                else:
+                    subprocess.run(shlex.split(er))
+
+        else:
+            package = _cwd / sr
+            init_module = package / "__init__.py"
+
+            if not init_module.exists():
+                module = _cwd / f"{sr}.py"
+
+                if not module.exists():
+                    raise FileNotFoundError(f"File {module} not found")
+
+                sys.path.append(str(_cwd))
+                module = importlib.import_module(sr)
+                getattr(module, er)()
+
+            else:
+                sys.path.append(str(package))
+                module = importlib.import_module("__init__")
+                getattr(module, er)()
+
+    except KeyboardInterrupt:
+        if sys.excepthook is sys.__excepthook__:
+            sys.excepthook = _no_traceback_eh
+        raise
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="qwe",
+        description="Run commands set in the pyproject.toml file",
+    )
+
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"qwe {__version__}"
+    )
+
+    subparser = parser.add_subparsers()
+
+    for entry, runner in _qwe.items():
+        _ = subparser.add_parser(entry, help=runner)
+        _.set_defaults(entry=entry, runner=runner)
+
+    args = parser.parse_args()
+    _run(*_split_runner(args.runner))
+
+
+if __name__ == "__main__":
+    main()