tgzr.cli 0.1.2__py3-none-any.whl

tgzr_cli-0.1.2.dist-info/METADATA

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: tgzr.cli
+Version: 0.1.2
+Summary: tgzr command line interface
+Project-URL: Documentation, https://github.com/open-tgzr/tgzr.cli#readme
+Project-URL: Issues, https://github.com/open-tgzr/tgzr.cli/issues
+Project-URL: Source, https://github.com/open-tgzr/tgzr.cli
+Author-email: Dee <dee.sometech@gmail.com>
+License-Expression: GPL-3.0-or-later
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: ==3.12.*
+Requires-Dist: click
+Requires-Dist: rich>=14.2.0
+Requires-Dist: uv>=0.9.15
+Description-Content-Type: text/markdown
+
+# tgzr.cli
+tgzr command line
+
+# Installation
+
+## Standalone Executable
+
+Download the executable corresponding to your platform on https://github.com/open-tgzr/tgzr.cli/releases
+
+## uvx
+
+To run `tgzr` without installation, you can use `uvx`. 
+The default command is `install`, so you can install `tgzr` with:
+
+`uvx --from tgzr.cli tgzr`\
+or\
+`uvx --from tgzr.cli tgzr --home /path/to/your/TGZR --studio MyStudioName`
+
+You can also run `tgzr` with plugins loaded from other pacakages.
+The default command becomes `app manager` when you install `tgzr.shell_apps.manager_panel`, so 
+you can run the manager with:
+
+`uvx --from tgzr.cli --with tgzr.shell_apps.manager_panel tgzr`
+
+## Python Package
+
+Create a virtual environment, activate it, and `pip install -U tgzr.cli`
+
+# Usage
+
+## Home
+
+### Lookup
+
+`tgzr` looks for a config file named `.tgzr` in the current directory. If the config file is not found there
+if looks for it in the parent directory and all parent's sub-directories, and goes on up until reaching the
+root directory or finding a Config file.
+
+To start the config lookup in another directory, you can use the `-H` or `--home` option:
+- `tgzr --home ~/TGZR ...`
+
+Once the config is found, we refer to its folder as **"home"**.
+
+### Manage
+
+- You can see the session config with:
+    - `tgzr session show`
+- You can save a config with:
+    - `tgzr session save` 
+    - This will bake the options into the config, so if you do:
+        - `tgzr --verbose session save`
+        - Next usage of `tgzr` will behave as if the `--verbose` option was specified.
+
+## Sub Commands
+
+`tgzr` provides different sub-commands depending from where you run it.
+
+A bare `tgzr` will only have `help` and `install` sub-commands.
+When installed (for example, using `tgzr install`), some plugins will then
+provide additionnal sub-commands.
+
+In order to activate a specific list of plugins, you need to run `tgzr` from an installed "Studio" . \
+All Studios contain a `tgzr` alias in their root directory (`tgzr.bat` for windows).\
+This is the command you want to run in order to use the plugins installed in that Studio.
+
+### Command short name
+
+Commands and Groups can be specified using their first letter(s) only, as long as
+their is no ambiguity on the command name you are aiming at.
+
+For example, let's say available commands are:
+- search
+- save
+- load
+
+Then, if entering `tgzr l` resolve to `tgzr load`.
+But entering `tgzr s` could resolve to `tgzr search` or `tgzr load`, so 
+you will receive an error. You should use at lease `tgzr se` or `tgzr sa`.
+
+### Getting Help
+
+- Use `-h` or `--help` after the sub-command name to get usage details:
+    - `tgzr <subcommand> --help`
+- Use the commands in the `help` group to get detailed information / tips:
+    - `tgzr help <topic>`
+
+
+
+
+## Env Vars
+
+You can config the session using environement variables.
+
+Use the `tgzr help env` command to list the name of all usable env vars.
+
+The env var name is the config field prepended with the appropriate prefix:
+- SessionConfig: `tgzr_<field_name>`
+- WorkspacesConfig: `tgzr_ws_<field_name>`
+- WorkspaceConfig: `tgzr_ws_default_<field_name>`
+
+You can open the config files saved in the session and workspaces to find 
+examples of the env var names.
+
+For example:
+- `tgzr_verbose=True tgzr config show` == `tgzr -v config show`
+- `tgzr_verbose=False tgzr config show` == `tgzr --quite config show`
+- `tgzr_ws_default_workspace_name=MyStudio tgzr ws show` == `tgzr ws --name MyStudio show`
+
+# Plugins
+
+`tgzr` command line is plugin based: all plugin installed in the current virtual env will
+be accessible in the command line.
+
+## Implement a Plugin
+
+To implement a plugin you need:
+- to declare entry point(s) in a `tgzr.cli.plugin` group.
+- to have the entry point(s) lead to a callable accepting one argument: the root click group
+
+__Example__: 
+> in `my_package/cli_plugin.py`:
+> ```python
+> import click
+>
+> @click.group()
+> def my_group():
+>     '''My Awesome commands'''
+>  
+> def install_plugin(group::click.Group):
+>     group.add_command(my_group)
+> ```
+>
+> in `pyproject.toml`:
+> 
+> ```
+> [project.entry-points."tgzr.cli.plugin"]
+> my_package = "my_package.cli_plugin:install_plugin"
+> ```
+
+# Installer
+
+Generate the installer with: `uv run pyinstaller pyinstaller_specs/tgzr-<platform>.spec`
+The `tgzr-<platform>` executable will be generated in the `dist/` folder

tgzr_cli-0.1.2.dist-info/RECORD

@@ -0,0 +1,14 @@
+tgzr/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tgzr/cli/__main__.py,sha256=d725Kn77hwTZ6V5Ly-7C379VmqKHHgnXDIZqCzBs8ws,156
+tgzr/cli/_version.py,sha256=Ok5oAXdWgR9aghaFXTafTeDW6sYO3uVe6d2Nket57R4,704
+tgzr/cli/add_plugins.py,sha256=bVQkD-wPneXDcYXNN3yDTnuBDdMaiAPLXGE_qfjER1w,3878
+tgzr/cli/install.py,sha256=jNjDn5yZUhzSF1ANfSkUx8NAEdQL2IoH1SeHtJWUrP4,5433
+tgzr/cli/install_cli.py,sha256=9edfEDe1orT5B0JiSQwPSKMF0GYwLBlPtHHNq7I5d8Q,3977
+tgzr/cli/main.py,sha256=XQM4OFWyM7NA45ZPMRW49l9HFdfrsSM96qrFJkZUv6s,94
+tgzr/cli/main_cli.py,sha256=h-5jg3xh1Nhgq2MrjIKghZhGP1Tyn_7lKfgWEMsKpPE,646
+tgzr/cli/utils.py,sha256=PGFvsZxTK8pAPUMCdBV2eF81AM413mp-KdplI1PVnHw,3499
+tgzr_cli-0.1.2.dist-info/METADATA,sha256=rzlLAOLdoVA1yo4Z230MCT-djsT5Cjr-5CIrWZT3vJY,5371
+tgzr_cli-0.1.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+tgzr_cli-0.1.2.dist-info/entry_points.txt,sha256=pivITpEbeeS6LA1ZpMpU1L6lRfTimzREACCOEDjTAog,44
+tgzr_cli-0.1.2.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+tgzr_cli-0.1.2.dist-info/RECORD,,

tgzr_cli-0.1.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

tgzr_cli-0.1.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+tgzr = tgzr.cli.main:main