Release 0.2.4

This commit adds the possibility of using a config file to specify
some params. For now, only the name_separator used by the gith branch -c
command.

It requires the user creates a config file in /home/user/.githconfig
with key: value

Author: rejamen

README.md

@@ -146,6 +146,8 @@ gith branch -c this is my branch name with spaces and other separator --name-sep
 ```
 This will replace the spaces with the specified separator: `this-is-my-branch-name-with-spaces-and-other-separator`
 
+If you are not happy with the default separator and do not want to pass the `--name-separator` flag every time no worries, there is a possibility to add a `.githconfig` file and set this value. Continue reading until the section *Using a Configuration file*
+
 In every of the previous cases, **gith** will **automatically checkout to the created branch** 😎
 
 If you want to create your branch, wihtout doing checkout, then just call the command like:
@@ -258,6 +260,21 @@ $ gith branch -d
 ```
 And you will get a list of local branches, with their indexes, so you can easily find the indexes without the need of typing an extra command.
 
+## Using a configuration file
+Adding a configuration file to set some default values while using **gith** is also possible. Right now, then only possible parameter to define is the `name_separator` used by the `gith branch -c` command, but in the future we might add other configurables there 😊
+
+In order to change the default value of this command, follow these steps:
+
+Create a file called `.githconfig` on your *Home* folder
+```
+nano ~/.githconfig
+```
+Add in this file the default separator you want to use while creating branches with spaces in the name. 
+```yaml
+name_separator: "-"
+```
+After that, you will be able to use `gith branch -c my branch name with spaces` and your configured separator will be used instead of the default.
+
 ## Final words
 **gith** is built using **Typer**. Big thanks 🙏 to [Sebastián Ramírez](https://github.com/tiangolo) for creating such amazing tool. 
 

gith/cli.py

@@ -4,11 +4,32 @@
 
 from .helpers import gith
 from .messages import GithMessage, GithMessageLevel
+from pathlib import Path
+import yaml
 
 app = typer.Typer()
 console = Console()
 
 
+def get_config_path() -> Path:
+    """
+    Get the path to the configuration file.
+    """
+    return Path.home() / ".githconfig"
+
+
+def load_config() -> dict:
+    """
+    Load the configuration file.
+    """
+    config_path = get_config_path()
+    if config_path.exists():
+        with open(config_path, "r") as f:
+            return yaml.safe_load(f)
+    return {}
+
+config = load_config()
+
 def branch_name_autocomplete(ctx: typer.Context, incomplete: str) -> List[str]:
     """
     Autocomplete function for branch names.
@@ -83,6 +104,8 @@ def branch(
     elif list or not list and not create and not branch_name:
         gith.git_branch()
     elif create:
+        # get name_separator from config file
+        name_separator = config.get("name_separator", False) or name_separator
         name = f"{name_separator}".join(branch_name)
         gith.create_branch(name, from_branch, checkout, name_separator)
         if checkout:

gith/helpers.py

@@ -1,5 +1,4 @@
 import subprocess
-import typer
 
 from .console import GithConsole
 from .messages import GithMessage, GithMessageLevel

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gith"
-version = "0.2.3"
+version = "0.2.4"
 description = "A Typer-based helper for Git operations"
 authors = [
     { name = "Reinaldo J. Menéndez", email = "rejamen@gmail.com" }
@@ -15,7 +15,8 @@ readme = "README.md"
 requires-python = ">=3.7"
 dependencies = [
     "typer>=0.15.1",
-    "rich >=10.11.0"
+    "rich>=10.11.0",
+    "pyyaml>=5.4"
 ]
 
 classifiers = [