gitonic 0.0.13__tar.gz → 0.0.14__tar.gz

{gitonic-0.0.13 → gitonic-0.0.14}/BACKLOG.md

@@ -63,6 +63,7 @@
   - adding single files 
   - open .gitignore for editing
 - execute git operations in parallel where possible
+- make expert mode debugging out better (use python logging)
 - 
 
 
@@ -86,6 +87,7 @@ refer to [issues](https://github.com/kr-g/gitonic/issues)
 - `gitonic` interacts with `git` just like starting in bash / commandline.
 at the present time there is _no_additional_ error checking. 
 this must be done by checking the log tab manually where all cmdline output goes.
-
+- at the present time the context menu only works on the underlying file (row) in the table. 
+ there is no support for multiple files (selection) as of now.
  
 

{gitonic-0.0.13 → gitonic-0.0.14}/CHANGELOG.md

@@ -1,8 +1,25 @@
-
+ 
 # Changelog
 
 
-# next version v0.0.13 - 20231125
+# version v0.0.14 - 20240518
+
+- improved formatter 
+  - support for multiple file extension for single config entry 
+  - support for path expansion for formatter config
+  - added sample for uncrustify (c, c++)
+- on "changes" tab
+  - added context menu to open file system explorer
+  - added support for custom context menu with `~/.gitonic/context.json`
+- calling merge-tool with more then more file selected on change tab will 
+ not block the user-interface anymore since starting independent from main process
+  - **important** add `--newtab` to `meld` configuration in `.gitconfig` 
+   to re-use an already running instance of `meld`
+- context menu handler expands user path (`~`)
+- 
+
+
+# version v0.0.13 - 20231125
 
 - show all untracked files on changes tab (not only the folder)
 - 

{gitonic-0.0.13 → gitonic-0.0.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitonic
-Version: 0.0.13
+Version: 0.0.14
 Summary: manage a multi git workspace
 Home-page: https://github.com/kr-g/gitonic
 Author: k. goger
@@ -29,7 +29,7 @@ License-File: LICENSE.md
 [![PEP-08](https://img.shields.io/badge/code%20style-PEP08-green.svg)](https://www.python.org/dev/peps/pep-0008/)
 
 
-you are reading VERSION = v0.0.13
+you are reading VERSION = v0.0.14
 
 
 # gitonic 
@@ -39,9 +39,6 @@ gitonic simplifies working with multiple git repositories.
 
 gitonic comes with an easy to use Tkinter GUI.
 
-there is also a plugin for thonny 
-[`thonny-gitonic`](https://github.com/kr-g/thonny-gitonic) 
-
 
 # background 
 
@@ -160,7 +157,11 @@ the general structure is:
       }
     }
 
-here `para` is an array of cmd-line options passed to the formatter command
+where `.file-ext` is a simple file extension such as `.py`, 
+or a comma separated list of extensions `.c,.h,.cpp`.
+wild-cards are not supported.
+
+where `para` is an array of cmd-line options passed to the formatter command
 where `%file` is a placeholder and replaced by the file name
 
 for different file extensions `gitonic` will call the formatter accordingly 
@@ -191,6 +192,20 @@ pycodestyle is an official tool from python's code quality authority.
       }
     }
 
+to use the same code formatter also for 
+[`cython's`](https://github.com/cython/cython) 
+files with extension `.pyx` change the setting to
+
+    {
+      ".py,.pyx": {
+        "cmd": "autopep8",
+        "para": [
+          "-i",
+          "%file"
+        ]
+      }
+    }
+
 
 ### black
 
@@ -225,6 +240,163 @@ that it is reported as error by pycodestyle after formatting.
     }
 
 
+## templates for c, c++ formatters
+
+all of the following tools are NOT part of `gitonic` standard installation. 
+
+
+### uncrustify
+
+[`uncrustify`](https://github.com/uncrustify/uncrustify) 
+is a code formatter for c, c++ (and other languages).
+
+here in this config sample it is configured for extensions `.c`, `.h`, and `.cpp`.
+
+IMPORTANT: `uncrustify` requires an additional config file, a sample can be found here
+[`uncrustify.cfg`](https://github.com/uncrustify/uncrustify/blob/master/forUncrustifySources.cfg)
+
+here in the sample the `uncrustify` config file is placed in path `~/.gitonic/uncrustify.cfg`.
+make sure that it is there.
+
+the following needs to be placed inside `~/.gitonic/formatter.json`
+
+
+    ".c,.h,.cpp": {
+        "cmd": "uncrustify",
+        "para": [
+              "-c",
+              "~/.gitonic/uncrustify.cfg",
+              "--replace",
+              "%file",
+              "--no-backup",
+              "--if-changed"
+        ]
+    }
+
+
+# custom context menu handler 
+
+when clicking on the `changes` tab right a context memu opens offering 
+to open the system file manager tool (file explorer) 
+at the base git repo path or at the changed file path.
+
+in addition it is possible to add own custom context menu entries here.
+configuration is done with `~/.gitonic/context.json` file.
+
+the general structure is:
+
+    {
+      "a-context-name-ctx": {
+        "expr": "*",
+        "menu": [
+          [
+            "some text $GIT",
+            [
+              "cmd-path",
+              "whatever_param=$GIT"
+            ]
+          ],
+          [
+            "some other text $PATH",
+            [
+              "cmd-path2",
+              "whatever_param=$PATH"
+            ]
+          ]
+        ]
+      },
+      ...
+    }
+
+
+here the variables `$GIT`, `$PATH`, or `$FILE` are replaced 
+by the corrosponding path before execution.
+
+the `expr` key contains a single file pattern, or a list of 
+file patterns - when to enable the context menu. 
+the file pattern is following Unix filename pattern matching.
+
+the `menu` array contains the text to display in the menu, 
+and the command params as embedded array.
+
+the context name as such can have any value 
+(as long it is unique in the structure).
+
+
+below a sample `~/.gitonic/context.json` file 
+for running on linux with xfce.
+
+    {
+      "term-ctx": {
+        "expr": "*",
+        "menu": [
+          [
+            "Open Terminal at $GIT",
+            [
+              "xfce4-terminal",
+              "--working-directory=$GIT"
+            ]
+          ],
+          [
+            "Open Terminal at $PATH",
+            [
+              "xfce4-terminal",
+              "--working-directory=$PATH"
+            ]
+          ],
+          [
+            "Edit .gitignore at $GIT",
+            [
+              "xed",
+              "$GIT/.gitignore"
+            ]
+          ]
+        ]
+      },
+      "spyder-ctx": {
+        "expr": "*.py",
+        "menu": [
+          [
+            "spyder python $FILE",
+            [
+              "~/spyder/.venv/bin/spyder",
+              "$FILE"
+            ]
+          ]
+        ]
+      },
+      "geany-ctx": {
+        "expr": [
+          "*.c",
+          "*.cpp",
+          "*.h"
+        ],
+        "menu": [
+          [
+            "geany c $FILE",
+            [
+              "geany",
+              "$FILE"
+            ]
+          ]
+        ]
+      }
+    }
+
+
+remark:
+the sample config file provides support for opening
+- terminal, in this case `xfce4-terminal`, can be replaced by e.g. `xterm` - depending on your distribution
+- `.gitignore` file for selected repo with [`xed`](https://en.wikipedia.org/wiki/Xed)
+- [`spyder-ide.org`](https://spyder-ide.org/), for files matching `*.py`
+- [`geany`](https://www.geany.org/), for files matching `*.c`, `*.cpp`, `*.h`
+
+
+**limitation:**
+
+at the present time the context menu only works on the underlying file (row) in the table.
+there is **no** support for multiple files (selection) as of now.
+
 
 
 # platform
@@ -319,7 +491,7 @@ when during startup an error is thrown, refer to
 # git configuration
 
 add a `.git-credentials` file as described here 
-[`git-credentials`](https://git-scm.com/docs/git-credential-store#_storage_format)
+[`git-credentials`](https://git-scm.com/docs/git-credential-store)
 
 
 add a `.gitconfig` file as described here
@@ -342,14 +514,14 @@ if meld is not installed pressing the button will have no effect.
     [difftool]
         prompt = false
     [difftool "meld"]
-        cmd = meld "$LOCAL" "$REMOTE"
+        cmd = meld --newtab "$LOCAL" "$REMOTE"
 
     [merge]
         tool = meld
     [mergetool "meld"]
         # Choose one of these 2 lines (not both!) 
         # cmd = meld "$LOCAL" "$MERGED" "$REMOTE" --output "$MERGED"
-        cmd = meld "$LOCAL" "$BASE" "$REMOTE" --output "$MERGED"
+        cmd = meld --newtab "$LOCAL" "$BASE" "$REMOTE" --output "$MERGED"
 
 
 # additional notes 
@@ -371,9 +543,10 @@ following files are used:
 |file|description|
 |---|---|
 |~/.gitonic/commit.json|the last commit messages show in the combo box|
-|~/.gitonic/tracked.json|tracked git repositories|
 |~/.gitonic/config.json|configuration settings|
+|~/.gitonic/context.json|configuration for context menu on changes tab|
 |~/.gitonic/formatter.json|configuration for external formatter tools|
+|~/.gitonic/tracked.json|tracked git repositories|
 |~/.gitonic/socket|internal use|
 
 
@@ -389,11 +562,28 @@ gitonic is released under the following
 
 
 
-
+ 
 # Changelog
 
 
-# next version v0.0.13 - 20231125
+# version v0.0.14 - 20240518
+
+- improved formatter 
+  - support for multiple file extension for single config entry 
+  - support for path expansion for formatter config
+  - added sample for uncrustify (c, c++)
+- on "changes" tab
+  - added context menu to open file system explorer
+  - added support for custom context menu with `~/.gitonic/context.json`
+- calling merge-tool with more then more file selected on change tab will 
+ not block the user-interface anymore since starting independent from main process
+  - **important** add `--newtab` to `meld` configuration in `.gitconfig` 
+   to re-use an already running instance of `meld`
+- context menu handler expands user path (`~`)
+- 
+
+
+# version v0.0.13 - 20231125
 
 - show all untracked files on changes tab (not only the folder)
 - 
@@ -574,6 +764,7 @@ gitonic is released under the following
   - adding single files 
   - open .gitignore for editing
 - execute git operations in parallel where possible
+- make expert mode debugging out better (use python logging)
 - 
 
 
@@ -597,7 +788,8 @@ refer to [issues](https://github.com/kr-g/gitonic/issues)
 - `gitonic` interacts with `git` just like starting in bash / commandline.
 at the present time there is _no_additional_ error checking. 
 this must be done by checking the log tab manually where all cmdline output goes.
-
+- at the present time the context menu only works on the underlying file (row) in the table. 
+ there is no support for multiple files (selection) as of now.
  
 
 

{gitonic-0.0.13 → gitonic-0.0.14}/README.md

@@ -1,7 +1,7 @@
 [![PEP-08](https://img.shields.io/badge/code%20style-PEP08-green.svg)](https://www.python.org/dev/peps/pep-0008/)
 
 
-you are reading VERSION = v0.0.13
+you are reading VERSION = v0.0.14
 
 
 # gitonic 
@@ -11,9 +11,6 @@ gitonic simplifies working with multiple git repositories.
 
 gitonic comes with an easy to use Tkinter GUI.
 
-there is also a plugin for thonny 
-[`thonny-gitonic`](https://github.com/kr-g/thonny-gitonic) 
-
 
 # background 
 
@@ -132,7 +129,11 @@ the general structure is:
       }
     }
 
-here `para` is an array of cmd-line options passed to the formatter command
+where `.file-ext` is a simple file extension such as `.py`, 
+or a comma separated list of extensions `.c,.h,.cpp`.
+wild-cards are not supported.
+
+where `para` is an array of cmd-line options passed to the formatter command
 where `%file` is a placeholder and replaced by the file name
 
 for different file extensions `gitonic` will call the formatter accordingly 
@@ -163,6 +164,20 @@ pycodestyle is an official tool from python's code quality authority.
       }
     }
 
+to use the same code formatter also for 
+[`cython's`](https://github.com/cython/cython) 
+files with extension `.pyx` change the setting to
+
+    {
+      ".py,.pyx": {
+        "cmd": "autopep8",
+        "para": [
+          "-i",
+          "%file"
+        ]
+      }
+    }
+
 
 ### black
 
@@ -197,6 +212,163 @@ that it is reported as error by pycodestyle after formatting.
     }
 
 
+## templates for c, c++ formatters
+
+all of the following tools are NOT part of `gitonic` standard installation. 
+
+
+### uncrustify
+
+[`uncrustify`](https://github.com/uncrustify/uncrustify) 
+is a code formatter for c, c++ (and other languages).
+
+here in this config sample it is configured for extensions `.c`, `.h`, and `.cpp`.
+
+IMPORTANT: `uncrustify` requires an additional config file, a sample can be found here
+[`uncrustify.cfg`](https://github.com/uncrustify/uncrustify/blob/master/forUncrustifySources.cfg)
+
+here in the sample the `uncrustify` config file is placed in path `~/.gitonic/uncrustify.cfg`.
+make sure that it is there.
+
+the following needs to be placed inside `~/.gitonic/formatter.json`
+
+
+    ".c,.h,.cpp": {
+        "cmd": "uncrustify",
+        "para": [
+              "-c",
+              "~/.gitonic/uncrustify.cfg",
+              "--replace",
+              "%file",
+              "--no-backup",
+              "--if-changed"
+        ]
+    }
+
+
+# custom context menu handler 
+
+when clicking on the `changes` tab right a context memu opens offering 
+to open the system file manager tool (file explorer) 
+at the base git repo path or at the changed file path.
+
+in addition it is possible to add own custom context menu entries here.
+configuration is done with `~/.gitonic/context.json` file.
+
+the general structure is:
+
+    {
+      "a-context-name-ctx": {
+        "expr": "*",
+        "menu": [
+          [
+            "some text $GIT",
+            [
+              "cmd-path",
+              "whatever_param=$GIT"
+            ]
+          ],
+          [
+            "some other text $PATH",
+            [
+              "cmd-path2",
+              "whatever_param=$PATH"
+            ]
+          ]
+        ]
+      },
+      ...
+    }
+
+
+here the variables `$GIT`, `$PATH`, or `$FILE` are replaced 
+by the corrosponding path before execution.
+
+the `expr` key contains a single file pattern, or a list of 
+file patterns - when to enable the context menu. 
+the file pattern is following Unix filename pattern matching.
+
+the `menu` array contains the text to display in the menu, 
+and the command params as embedded array.
+
+the context name as such can have any value 
+(as long it is unique in the structure).
+
+
+below a sample `~/.gitonic/context.json` file 
+for running on linux with xfce.
+
+    {
+      "term-ctx": {
+        "expr": "*",
+        "menu": [
+          [
+            "Open Terminal at $GIT",
+            [
+              "xfce4-terminal",
+              "--working-directory=$GIT"
+            ]
+          ],
+          [
+            "Open Terminal at $PATH",
+            [
+              "xfce4-terminal",
+              "--working-directory=$PATH"
+            ]
+          ],
+          [
+            "Edit .gitignore at $GIT",
+            [
+              "xed",
+              "$GIT/.gitignore"
+            ]
+          ]
+        ]
+      },
+      "spyder-ctx": {
+        "expr": "*.py",
+        "menu": [
+          [
+            "spyder python $FILE",
+            [
+              "~/spyder/.venv/bin/spyder",
+              "$FILE"
+            ]
+          ]
+        ]
+      },
+      "geany-ctx": {
+        "expr": [
+          "*.c",
+          "*.cpp",
+          "*.h"
+        ],
+        "menu": [
+          [
+            "geany c $FILE",
+            [
+              "geany",
+              "$FILE"
+            ]
+          ]
+        ]
+      }
+    }
+
+
+remark:
+the sample config file provides support for opening
+- terminal, in this case `xfce4-terminal`, can be replaced by e.g. `xterm` - depending on your distribution
+- `.gitignore` file for selected repo with [`xed`](https://en.wikipedia.org/wiki/Xed)
+- [`spyder-ide.org`](https://spyder-ide.org/), for files matching `*.py`
+- [`geany`](https://www.geany.org/), for files matching `*.c`, `*.cpp`, `*.h`
+
+
+**limitation:**
+
+at the present time the context menu only works on the underlying file (row) in the table.
+there is **no** support for multiple files (selection) as of now.
+
 
 
 # platform
@@ -291,7 +463,7 @@ when during startup an error is thrown, refer to
 # git configuration
 
 add a `.git-credentials` file as described here 
-[`git-credentials`](https://git-scm.com/docs/git-credential-store#_storage_format)
+[`git-credentials`](https://git-scm.com/docs/git-credential-store)
 
 
 add a `.gitconfig` file as described here
@@ -314,14 +486,14 @@ if meld is not installed pressing the button will have no effect.
     [difftool]
         prompt = false
     [difftool "meld"]
-        cmd = meld "$LOCAL" "$REMOTE"
+        cmd = meld --newtab "$LOCAL" "$REMOTE"
 
     [merge]
         tool = meld
     [mergetool "meld"]
         # Choose one of these 2 lines (not both!) 
         # cmd = meld "$LOCAL" "$MERGED" "$REMOTE" --output "$MERGED"
-        cmd = meld "$LOCAL" "$BASE" "$REMOTE" --output "$MERGED"
+        cmd = meld --newtab "$LOCAL" "$BASE" "$REMOTE" --output "$MERGED"
 
 
 # additional notes 
@@ -343,9 +515,10 @@ following files are used:
 |file|description|
 |---|---|
 |~/.gitonic/commit.json|the last commit messages show in the combo box|
-|~/.gitonic/tracked.json|tracked git repositories|
 |~/.gitonic/config.json|configuration settings|
+|~/.gitonic/context.json|configuration for context menu on changes tab|
 |~/.gitonic/formatter.json|configuration for external formatter tools|
+|~/.gitonic/tracked.json|tracked git repositories|
 |~/.gitonic/socket|internal use|
 
 

gitonic-0.0.14/gitonic/const.py

@@ -0,0 +1 @@
+VERSION = "v0.0.14"