semtag 0.1.3__tar.gz → 0.2.1__tar.gz

{semtag-0.1.3 → semtag-0.2.1}/.gitignore

@@ -56,6 +56,9 @@ venv.bak/
 *.swo
 *~
 
+# Linter
+.ansible/
+
 # OS
 .DS_Store
 Thumbs.db

{semtag-0.1.3 → semtag-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: semtag
-Version: 0.1.3
+Version: 0.2.1
 Summary: A tool for managing semantic version tags in git repositories
 Author-email: Mateusz Mikrut <mateusz.mikrut@gmail.com>
 License-Expression: MIT
@@ -25,7 +25,7 @@ Dynamic: license-file
 
 # Semantic Version GIT Tagger
 
-A pretty trivial python script to easely manage git tags with semantic versioning (semver.org)  
+A pretty trivial python script to easily manage git tags with semantic versioning (semver.org)  
 
 ## Usage
 
@@ -35,15 +35,21 @@ semtag [options]
 
 ### Options
 
-- `-p, --patch` - Increment patch version (x.x.PATCH)
-- `-m, --minor` - Increment minor version (x.MINOR.0)
-- `-M, --major` - Increment major version (MAJOR.0.0)
-- `-b, --by` - Increment by a specific number (default: 1)
-- `-l, --label` - Add label to the version (e.g., -l rc1 creates 1.0.0-rc1)
-- `-u, --push` - Push the new tag to remote repository
-- `-n, --nofetch` - Do not fetch tags from remote prior creating new one
-<!-- - `-f, --force` - Force operation even if not on main/master branch -->
-- `-v, --verbose` - Increase verbosity (use -v, -vv, or -vvv for more detail)
+<!-- OPTIONS:START -->
+```
+  -h, --help         show this help message and exit
+  -v, --verbose      Verbosity (-v for INFO, -vv for DEBUG)
+  -b, --by BY        Increment by a specific number
+  -p, --patch        Increment patch version (x.x.PATCH)
+  -m, --minor        Increment minor version (x.MINOR.0)
+  -M, --major        Increment major version (MAJOR.0.0)
+  -l, --label LABEL  Add label to the version (e.g., -l rc1 creates 1.0.0-rc1)
+  -a, --msg MSG      Annotated tags message
+  -u, --push         Push the new tag to remote repository
+  -U, --pushall      Push all local tags to remote repository
+  -n, --no-fetch     Do not fetch tags from remote before operation
+```
+<!-- OPTIONS:END -->
 
 ### Examples
 

{semtag-0.1.3 → semtag-0.2.1}/README.md

@@ -1,6 +1,6 @@
 # Semantic Version GIT Tagger
 
-A pretty trivial python script to easely manage git tags with semantic versioning (semver.org)  
+A pretty trivial python script to easily manage git tags with semantic versioning (semver.org)  
 
 ## Usage
 
@@ -10,15 +10,21 @@ semtag [options]
 
 ### Options
 
-- `-p, --patch` - Increment patch version (x.x.PATCH)
-- `-m, --minor` - Increment minor version (x.MINOR.0)
-- `-M, --major` - Increment major version (MAJOR.0.0)
-- `-b, --by` - Increment by a specific number (default: 1)
-- `-l, --label` - Add label to the version (e.g., -l rc1 creates 1.0.0-rc1)
-- `-u, --push` - Push the new tag to remote repository
-- `-n, --nofetch` - Do not fetch tags from remote prior creating new one
-<!-- - `-f, --force` - Force operation even if not on main/master branch -->
-- `-v, --verbose` - Increase verbosity (use -v, -vv, or -vvv for more detail)
+<!-- OPTIONS:START -->
+```
+  -h, --help         show this help message and exit
+  -v, --verbose      Verbosity (-v for INFO, -vv for DEBUG)
+  -b, --by BY        Increment by a specific number
+  -p, --patch        Increment patch version (x.x.PATCH)
+  -m, --minor        Increment minor version (x.MINOR.0)
+  -M, --major        Increment major version (MAJOR.0.0)
+  -l, --label LABEL  Add label to the version (e.g., -l rc1 creates 1.0.0-rc1)
+  -a, --msg MSG      Annotated tags message
+  -u, --push         Push the new tag to remote repository
+  -U, --pushall      Push all local tags to remote repository
+  -n, --no-fetch     Do not fetch tags from remote before operation
+```
+<!-- OPTIONS:END -->
 
 ### Examples
 

{semtag-0.1.3 → semtag-0.2.1}/semtag.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: semtag
-Version: 0.1.3
+Version: 0.2.1
 Summary: A tool for managing semantic version tags in git repositories
 Author-email: Mateusz Mikrut <mateusz.mikrut@gmail.com>
 License-Expression: MIT
@@ -25,7 +25,7 @@ Dynamic: license-file
 
 # Semantic Version GIT Tagger
 
-A pretty trivial python script to easely manage git tags with semantic versioning (semver.org)  
+A pretty trivial python script to easily manage git tags with semantic versioning (semver.org)  
 
 ## Usage
 
@@ -35,15 +35,21 @@ semtag [options]
 
 ### Options
 
-- `-p, --patch` - Increment patch version (x.x.PATCH)
-- `-m, --minor` - Increment minor version (x.MINOR.0)
-- `-M, --major` - Increment major version (MAJOR.0.0)
-- `-b, --by` - Increment by a specific number (default: 1)
-- `-l, --label` - Add label to the version (e.g., -l rc1 creates 1.0.0-rc1)
-- `-u, --push` - Push the new tag to remote repository
-- `-n, --nofetch` - Do not fetch tags from remote prior creating new one
-<!-- - `-f, --force` - Force operation even if not on main/master branch -->
-- `-v, --verbose` - Increase verbosity (use -v, -vv, or -vvv for more detail)
+<!-- OPTIONS:START -->
+```
+  -h, --help         show this help message and exit
+  -v, --verbose      Verbosity (-v for INFO, -vv for DEBUG)
+  -b, --by BY        Increment by a specific number
+  -p, --patch        Increment patch version (x.x.PATCH)
+  -m, --minor        Increment minor version (x.MINOR.0)
+  -M, --major        Increment major version (MAJOR.0.0)
+  -l, --label LABEL  Add label to the version (e.g., -l rc1 creates 1.0.0-rc1)
+  -a, --msg MSG      Annotated tags message
+  -u, --push         Push the new tag to remote repository
+  -U, --pushall      Push all local tags to remote repository
+  -n, --no-fetch     Do not fetch tags from remote before operation
+```
+<!-- OPTIONS:END -->
 
 ### Examples
 

{semtag-0.1.3 → semtag-0.2.1}/semtag.egg-info/SOURCES.txt

@@ -5,11 +5,11 @@ SemanticVersion.py
 pyproject.toml
 requirements.txt
 semtag.py
-.ansible/.lock
 .github/workflows/publish.yml
 semtag.egg-info/PKG-INFO
 semtag.egg-info/SOURCES.txt
 semtag.egg-info/dependency_links.txt
 semtag.egg-info/entry_points.txt
 semtag.egg-info/requires.txt
-semtag.egg-info/top_level.txt
+semtag.egg-info/top_level.txt
+tools/pre-commit

{semtag-0.1.3 → semtag-0.2.1}/semtag.py

@@ -14,19 +14,12 @@ logger = logging.getLogger(__name__)
 
 def main():
   """ Main function """
-  ########################
-  ### Argument Parsing ###
-  ########################
+  
+  ### Arguments
   parser = argparse.ArgumentParser(
     description='SemTag - Manage semantic version tags in git repositories',
     formatter_class=argparse.RawDescriptionHelpFormatter,
-    epilog="""
-Examples:
-  %(prog)s -m              # Increment minor version (1.0.0 -> 1.1.0)
-  %(prog)s -M              # Increment major version (1.0.0 -> 2.0.0)
-  %(prog)s -p -b 5         # Increment patch version by 5 (1.0.0 -> 1.0.5)
-  %(prog)s -p -l rc1       # Increment patch and add label (1.0.0 -> 1.0.1-rc1)
-        """
+    epilog="\n"
   )
   parser.add_argument('-v', '--verbose', action='count', default=0, help='Verbosity (-v for INFO, -vv for DEBUG)')
   # parser.add_argument('-f', '--force', action='store_true', default=False, help='Force the operation even if not on main/master branch')
@@ -38,11 +31,13 @@ Examples:
   version_group.add_argument('-M', '--major', action='store_true', help='Increment major version (MAJOR.0.0)')
   
   parser.add_argument('-l', '--label', type=str, default=None, help='Add label to the version (e.g., -l rc1 creates 1.0.0-rc1)')
+  parser.add_argument('-a', '--msg', type=str, help='Annotated tags message', default=None)
   parser.add_argument('-u', '--push', action='store_true', help='Push the new tag to remote repository', default=False)
+  parser.add_argument('-U', '--pushall', action='store_true', help='Push all local tags to remote repository', default=False)
   parser.add_argument('-n', '--no-fetch', action='store_true', help='Do not fetch tags from remote before operation', default=False)
   args = parser.parse_args()
   
-  ### Logging based on verbosity ###
+  ### Logging based on verbosity 
   if args.verbose == 0:
     log_level = logging.WARNING
   elif args.verbose == 1:
@@ -54,14 +49,12 @@ Examples:
     level=log_level,
     format='%(message)s' # Keep it simple (no timestamps, severity etc.)
   )
-  
-  ##################
-  ### Main Logic ###
-  ##################
+
+  ### Main Logic 
   logger.debug(f"Arguments: {args}")
   pwd = Path('.').resolve()
 
-  ### Check if this is a git workspace ###
+  ### Check if this is a git workspace 
   try:
     repo = git.Repo(pwd, search_parent_directories=True)
     logger.debug(f"Found git repository at {repo.working_dir}")
@@ -73,7 +66,7 @@ Examples:
     exit(99)
   
   reponame = Path(repo.working_dir).name
-  logger.debug(f"Repository name : {reponame}")
+  logger.info(f"Repository name : {reponame}")
   
   ## Check if on main/master branch (warning only)
   # try:
@@ -84,30 +77,31 @@ Examples:
   #   logger.warning("HEAD is detached, not on any branch")
   #   exit(2)
   
-
-  # Fetch tags from remote to avoid duplicates
+  ### Fetch tags from remote to avoid duplicates
   if not args.no_fetch:
     try:
       logger.debug("Fetching tags from remote...")
       repo.remotes.origin.fetch(tags=True)
-      logger.debug("Tags fetched successfully")
+      logger.info("Tags fetched successfully")
     except Exception as e:
       logger.warning(f"Error fetching tags: {e}")
-    
+
+  ### Sort and filter semantic tags 
+  logger.debug(f"All tags in repository: {repo.tags}")
   tags = semsort([tag.name for tag in repo.tags])
+  logger.debug(f"Sorted semantic tags: {tags}")
   
+  ### No tags case
   if tags:
     latest_tag = tags[0]
-    logger.debug(f"Latest semantic version tag: {latest_tag}")
+    logger.info(f"Latest semantic version tag: {latest_tag}")
   else:
-    # No tags found, start with 0.0.0
-    logger.debug("No semantic version tags found. Starting with 0.0.0")
     latest_tag = '0.0.0'
+    logger.info("No semantic version tags found. Starting with 0.0.0")
     
-  # Initialize obj
   current_version = SemanticVersion(latest_tag)
   
-  ### Increment version ###
+  ### Increment version 
   if args.major:
     logger.debug("Incrementing major version")
     current_version.inc_major(by=args.by)
@@ -118,24 +112,32 @@ Examples:
     logger.debug("Incrementing patch version")
     current_version.inc_patch(by=args.by)
   
-  ### Label ###
+  ### Label 
   if args.label:
     logger.debug(f"Adding label: {args.label}")
     current_version.add_label(args.label)
   
   new_tag = str(current_version)
-  logger.info(f"Generate tag: {new_tag}")
+  logger.debug(f"Generated new tag: {new_tag}")
     
-  ### Create and push
+  ### Create tag
   try:
-    #TODO: add tag message option later
-    #repo.create_tag(new_tag, message=f"Release {new_tag}")
-    repo.create_tag(new_tag)
+    if args.msg:
+      logger.debug(f"Creating annotated tag '{new_tag}' with message: {args.msg}")
+      repo.create_tag(new_tag, message=args.msg)
+    else:
+      logger.debug(f"Creating lightweight tag '{new_tag}'")
+      repo.create_tag(new_tag)
+  
     logger.info(f"Successfully created tag: {new_tag}")
     
-    # Push if requested
-    if args.push:
-      logger.info(f"Pushing tag '{new_tag}' to remote...")
+    ### Push 
+    if args.pushall:
+      logger.debug("Pushing all local tags to remote...")
+      repo.remote('origin').push(tags=True)
+      logger.info("Successfully pushed all tags to remote")
+    elif args.push:
+      logger.debug(f"Pushing tag '{new_tag}' to remote...")
       repo.remote('origin').push(new_tag) # It only pushes the new tag not all from local repo
       logger.info(f"Successfully pushed new tag: {new_tag}")
     else:
@@ -145,7 +147,7 @@ Examples:
   except Exception as e:
     logger.error(f"Error: {e}")  
 
-  # Print the new tag to stout as confirmation if not verbose
+  ### Print the new tag to stout as confirmation if not verbose
   if args.verbose == 0:
     GREEN = '\033[92m'
     YELLOW = '\033[93m'

semtag-0.2.1/tools/pre-commit

@@ -0,0 +1,38 @@
+#!/bin/bash
+# Pre-commit hook to generate README.md options from script argparse help
+
+### Install pre-commit hook:
+# ln -s ./tools/pre-commit/pre-commit .git/hooks/pre-commit
+
+REPO_ROOT=$(git rev-parse --show-toplevel)
+
+# Check if semtag.py has been modified
+if git diff --cached --name-only | grep -q 'semtag\.py'; then
+  echo "Updating README.md options..."
+  cd "$REPO_ROOT" || exit 1
+
+  OPTIONS_TMP=$(mktemp)
+  README_TMP=$(mktemp)
+
+  python semtag.py --help 2>&1 | sed -n '/^options:/,/^$/p' | tail -n +2 > "$OPTIONS_TMP"
+
+  # README with updated options
+  awk -v opts_file="$OPTIONS_TMP" '
+    /<!-- OPTIONS:START -->/ { print; print "```"; system("cat " opts_file); print "```"; skip=1; next }
+    /<!-- OPTIONS:END -->/ { skip=0 }
+    !skip
+  ' README.md > "$README_TMP"
+    
+  if [ $? -eq 0 ]; then
+    mv "$README_TMP" README.md
+    rm -f "$OPTIONS_TMP"
+    git add README.md
+    echo "README.md options updated and staged"
+  else
+    echo "Failed to update README.md"
+    rm -f "$README_TMP" "$OPTIONS_TMP"
+    exit 1
+  fi
+fi
+
+exit 0