From e47ae1ee59c6f6cdb4e7c329c574cf18bd9a7db8 Mon Sep 17 00:00:00 2001 From: sumansaurabh Date: Wed, 30 Apr 2025 20:17:07 +0530 Subject: [PATCH 1/2] Refactor CLI command names from 'penifycli' to 'penify' for consistency across documentation and codebase --- README.md | 28 +++++------ docs/commit-commands.md | 34 ++++++------- docs/config-commands.md | 10 ++-- docs/detailed-usage.md | 16 +++--- docs/doc_commands.md | 70 +++++++++++++-------------- docs/example-workflows.md | 24 ++++----- docs/penify-cli-documentation.md | 40 +++++++-------- penify_hook/commands/doc_commands.py | 2 +- penify_hook/commands/hook_commands.py | 4 +- penify_hook/main.py | 4 +- setup.py | 6 +-- 11 files changed, 119 insertions(+), 119 deletions(-) diff --git a/README.md b/README.md index db0ad8c..733670c 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ A CLI tool to generate smart commit messages, code documentation, and more. Install from PyPI: ```bash -pip install penifycli +pip install penify ``` ## Usage @@ -31,7 +31,7 @@ Penify CLI provides several subcommands for different functionalities, organized Generate smart commit messages using local LLM: ```bash -penifycli commit [-m "Optional message"] [-e] [-d] +penify commit [-m "Optional message"] [-e] [-d] ``` Options: @@ -45,16 +45,16 @@ Configure local LLM and JIRA settings: ```bash # Configure LLM settings -penifycli config llm --model MODEL_NAME [--api-base API_URL] [--api-key API_KEY] +penify config llm --model MODEL_NAME [--api-base API_URL] [--api-key API_KEY] # Configure LLM settings through web interface -penifycli config llm-web +penify config llm-web # Configure JIRA settings -penifycli config jira --url JIRA_URL --username USERNAME --api-token TOKEN [--verify] +penify config jira --url JIRA_URL --username USERNAME --api-token TOKEN [--verify] # Configure JIRA settings through web interface -penifycli config jira-web +penify config jira-web ``` ## Advanced Commands (Login required) @@ -64,7 +64,7 @@ penifycli config jira-web To log in and obtain an API token: ```bash -penifycli login +penify login ``` This command will open a browser window for authentication. After successful login, the API key will be saved locally for future use. @@ -75,10 +75,10 @@ Generate documentation for Git diff, files or folders: ```bash # Generate documentation for latest Git commit diff -penifycli docgen +penify docgen # Generate documentation for specific file or folder -penifycli docgen -l /path/to/file/or/folder +penify docgen -l /path/to/file/or/folder ``` Options: @@ -90,10 +90,10 @@ Install or uninstall Git post-commit hooks: ```bash # Install Git hook -penifycli docgen install-hook [-l /path/to/repo] +penify docgen install-hook [-l /path/to/repo] # Uninstall Git hook -penifycli docgen uninstall-hook [-l /path/to/repo] +penify docgen uninstall-hook [-l /path/to/repo] ``` Options: @@ -110,7 +110,7 @@ If no token is available and you try to access an advanced feature, you'll be pr For commit message generation, Penify can use a local LLM. Configure it using: ```bash -penifycli config llm --model MODEL_NAME --api-base API_URL --api-key API_KEY +penify config llm --model MODEL_NAME --api-base API_URL --api-key API_KEY ``` Common configurations: @@ -122,7 +122,7 @@ Common configurations: Configure JIRA integration to enhance commit messages with issue details: ```bash -penifycli config jira --url https://your-domain.atlassian.net --username your-email@example.com --api-token YOUR_API_TOKEN +penify config jira --url https://your-domain.atlassian.net --username your-email@example.com --api-token YOUR_API_TOKEN ``` ## Development @@ -159,7 +159,7 @@ Contributions are welcome! Please feel free to submit a Pull Request. ## Issues -If you encounter any problems or have suggestions, please file an issue on the [GitHub repository](https://github.com/SingularityX-ai/penifycli/issues). +If you encounter any problems or have suggestions, please file an issue on the [GitHub repository](https://github.com/SingularityX-ai/penify/issues). ## Support diff --git a/docs/commit-commands.md b/docs/commit-commands.md index 5eab520..15b0ab3 100644 --- a/docs/commit-commands.md +++ b/docs/commit-commands.md @@ -5,7 +5,7 @@ The `commit` command allows you to generate smart, AI-powered commit messages fo ## Basic Usage ```bash -penifycli commit +penify commit ``` By default, this command: @@ -20,7 +20,7 @@ By default, this command: Provide context for the commit message generation: ```bash -penifycli commit -m "Fix login flow" +penify commit -m "Fix login flow" ``` This hint helps the AI understand your intention and improves the quality of the generated message. @@ -30,7 +30,7 @@ This hint helps the AI understand your intention and improves the quality of the Open an editor to review and edit the generated commit message before committing: ```bash -penifycli commit -e +penify commit -e ``` This opens your default Git editor with the generated message for review. @@ -40,7 +40,7 @@ This opens your default Git editor with the generated message for review. Generate a detailed commit message with both title and description: ```bash -penifycli commit -d +penify commit -d ``` Without this flag, only the commit title is generated. @@ -52,32 +52,32 @@ You can combine these options for different workflows: ### Generate Title Only with Context ```bash -penifycli commit -m "Update login UI" +penify commit -m "Update login UI" ``` ### Generate Title and Description with Context ```bash -penifycli commit -m "Update login UI" -d +penify commit -m "Update login UI" -d ``` ### Generate and Edit Full Commit Message ```bash -penifycli commit -d -e +penify commit -d -e ``` ### Generate, Edit, and Provide Context ```bash -penifycli commit -m "Refactor authentication" -d -e +penify commit -m "Refactor authentication" -d -e ``` ## LLM and JIRA Integration ### Using Local LLM -If you've configured a local LLM using `penifycli config llm`, the commit command will automatically use it for message generation. +If you've configured a local LLM using `penify config llm`, the commit command will automatically use it for message generation. Benefits: - Privacy: your code changes don't leave your machine @@ -86,7 +86,7 @@ Benefits: ### JIRA Enhancement -If you've configured JIRA integration using `penifycli config jira`, the commit command will: +If you've configured JIRA integration using `penify config jira`, the commit command will: 1. Detect JIRA issue references in your changes 2. Fetch issue details from your JIRA instance @@ -109,11 +109,11 @@ PROJ-123: Fix authentication bug in login flow For the `commit` command to work: 1. You must have configured either: - - Local LLM via `penifycli config llm`, OR - - Logged in via `penifycli login` + - Local LLM via `penify config llm`, OR + - Logged in via `penify login` 2. For JIRA enhancement (optional): - - Configure JIRA via `penifycli config jira` + - Configure JIRA via `penify config jira` ## Examples @@ -124,7 +124,7 @@ For the `commit` command to work: git add . # Generate commit message -penifycli commit +penify commit # Commit with the generated message git commit -m "Generated message here" @@ -138,7 +138,7 @@ git add . # Generate detailed commit message with JIRA integration, # provide context, and open editor for review -penifycli commit -m "Fix login issue" -d -e +penify commit -m "Fix login issue" -d -e # The commit is automatically completed after you save and exit the editor ``` @@ -148,8 +148,8 @@ penifycli commit -m "Fix login issue" -d -e ### Common Issues 1. **"No LLM model or API token provided"** - - Run `penifycli config llm` to configure a local LLM, or - - Run `penifycli login` to authenticate with Penify + - Run `penify config llm` to configure a local LLM, or + - Run `penify login` to authenticate with Penify 2. **"Failed to connect to JIRA"** - Check your JIRA configuration with `cat ~/.penify` diff --git a/docs/config-commands.md b/docs/config-commands.md index 2174ced..0414f8e 100644 --- a/docs/config-commands.md +++ b/docs/config-commands.md @@ -14,17 +14,17 @@ Penify CLI stores configuration in a JSON file at `~/.penify/config.json`. The c ```bash # Configure LLM settings -penifycli config llm +penify config llm # Configure JIRA integration -penifycli config jira +penify config jira ``` ## LLM Configuration ### Web Interface -Running `penifycli config llm` opens a web interface in your browser where you can configure: +Running `penify config llm` opens a web interface in your browser where you can configure: 1. **Model**: The LLM model to use (e.g., `gpt-3.5-turbo`) 2. **API Base URL**: The endpoint URL for your LLM API (e.g., `https://api.openai.com/v1`) @@ -72,7 +72,7 @@ After configuration, your `~/.penify/config.json` will contain: ### Web Interface -Running `penifycli config jira` opens a web interface where you can configure: +Running `penify config jira` opens a web interface where you can configure: 1. **JIRA URL**: Your JIRA instance URL (e.g., `https://yourcompany.atlassian.net`) 2. **Username**: Your JIRA username (typically your email) @@ -123,7 +123,7 @@ You can override configuration settings using environment variables: Example: ```bash export PENIFY_LLM_MODEL="gpt-4" -penifycli commit +penify commit ``` ## Command-Line Configuration diff --git a/docs/detailed-usage.md b/docs/detailed-usage.md index 70cd6d9..4b5441c 100644 --- a/docs/detailed-usage.md +++ b/docs/detailed-usage.md @@ -31,7 +31,7 @@ This document provides in-depth information about all features and capabilities ### Login Process -When you run `penifycli login`, the tool: +When you run `penify login`, the tool: 1. Opens your default web browser 2. Redirects you to Penify's login page @@ -58,7 +58,7 @@ API tokens are stored in your home directory in the `.penify` file. This JSON fi ## Command Overview ``` -penifycli +penify ├── commit Generate smart commit messages ├── config Configure local LLM and JIRA │ ├── llm Configure local LLM settings @@ -91,7 +91,7 @@ The `docgen` command generates documentation for your code: ### Authentication Requirement -This feature requires authentication with a Penify account. Run `penifycli login` before using documentation features. +This feature requires authentication with a Penify account. Run `penify login` before using documentation features. ## Configuration Settings @@ -108,16 +108,16 @@ Penify can install Git hooks to automate documentation generation: ### Post-Commit Hook -- **Install**: `penifycli docgen install-hook` +- **Install**: `penify docgen install-hook` - **What it does**: Automatically generates documentation for changed files after each commit -- **Uninstall**: `penifycli docgen uninstall-hook` +- **Uninstall**: `penify docgen uninstall-hook` ### Custom Hook Location You can specify a custom location for Git hooks: ```bash -penifycli docgen install-hook -l /path/to/git/repo +penify docgen install-hook -l /path/to/git/repo ``` ## Advanced Use Cases @@ -136,14 +136,14 @@ Generate documentation for an entire repository: ```bash git clone https://github.com/user/repo cd repo -penifycli docgen -l . +penify docgen -l . ``` ## Troubleshooting ### Common Issues -1. **API Key Errors**: Ensure you've run `penifycli login` or set `PENIFY_API_TOKEN` +1. **API Key Errors**: Ensure you've run `penify login` or set `PENIFY_API_TOKEN` 2. **LLM Configuration**: Check your LLM settings with `cat ~/.penify` 3. **JIRA Integration**: Verify JIRA credentials in your configuration diff --git a/docs/doc_commands.md b/docs/doc_commands.md index 9d8c633..bdc03f7 100644 --- a/docs/doc_commands.md +++ b/docs/doc_commands.md @@ -17,13 +17,13 @@ This document provides a detailed guide to all permutations and combinations of ## Basic Usage ```bash -penifycli docgen +penify docgen ``` By default, this command: - Analyzes the current Git diff (changes since last commit) - Generates documentation for changed files only -- Requires authentication via `penifycli login` +- Requires authentication via `penify login` ## Command Options @@ -33,10 +33,10 @@ Specify a target for documentation generation: ```bash # Generate documentation for a specific file -penifycli docgen -l path/to/file.py +penify docgen -l path/to/file.py # Generate documentation for a specific folder -penifycli docgen -l path/to/folder +penify docgen -l path/to/folder ``` Without this flag, Penify analyzes only Git-tracked modified files. @@ -48,7 +48,7 @@ Without this flag, Penify analyzes only Git-tracked modified files. Install a Git post-commit hook to automatically generate documentation: ```bash -penifycli docgen install-hook +penify docgen install-hook ``` #### `uninstall-hook` @@ -56,7 +56,7 @@ penifycli docgen install-hook Remove the Git post-commit hook: ```bash -penifycli docgen uninstall-hook +penify docgen uninstall-hook ``` ## Option Combinations @@ -65,49 +65,49 @@ penifycli docgen uninstall-hook ```bash # Basic usage - current Git diff -penifycli docgen +penify docgen ``` ### Generate Documentation for a Specific File ```bash # Single file documentation -penifycli docgen -l src/main.py +penify docgen -l src/main.py ``` ### Generate Documentation for a Folder ```bash # Folder documentation -penifycli docgen -l src/models/ +penify docgen -l src/models/ ``` ### Install Hook in Current Repository ```bash # Install hook in current Git repository -penifycli docgen install-hook +penify docgen install-hook ``` ### Install Hook in Specific Repository ```bash # Install hook in a specific Git repository -penifycli docgen install-hook -l /path/to/repo +penify docgen install-hook -l /path/to/repo ``` ### Uninstall Hook from Current Repository ```bash # Uninstall hook from current Git repository -penifycli docgen uninstall-hook +penify docgen uninstall-hook ``` ### Uninstall Hook from Specific Repository ```bash # Uninstall hook from a specific Git repository -penifycli docgen uninstall-hook -l /path/to/repo +penify docgen uninstall-hook -l /path/to/repo ``` ## Git Hook Commands @@ -118,11 +118,11 @@ Penify provides Git hook commands to automate documentation generation as part o #### How Hooks Work -When you install a Git hook with `penifycli docgen install-hook`, Penify: +When you install a Git hook with `penify docgen install-hook`, Penify: 1. Creates a post-commit hook script in the `.git/hooks` directory 2. Makes the script executable -3. Configures the hook to run `penifycli docgen` after each commit +3. Configures the hook to run `penify docgen` after each commit #### Hook Script Content @@ -130,10 +130,10 @@ The generated post-commit hook contains: ```bash #!/bin/sh -# This is a post-commit hook generated by penifycli. +# This is a post-commit hook generated by penify. # Automatically generates documentation for changed files after each commit. -penifycli docgen -gf /path/to/git/repository -t your_api_token +penify docgen -gf /path/to/git/repository -t your_api_token ``` #### Installation Location @@ -141,13 +141,13 @@ penifycli docgen -gf /path/to/git/repository -t your_api_token By default, hooks are installed in the current Git repository. You can specify a different location: ```bash -penifycli docgen install-hook -l /path/to/repo +penify docgen install-hook -l /path/to/repo ``` #### Installation Requirements To install hooks, you need: -- A valid Penify API token (login first with `penifycli login`) +- A valid Penify API token (login first with `penify login`) - Write permissions to the `.git/hooks` directory #### Verifying Installation @@ -165,18 +165,18 @@ You can customize the post-commit hook after installation: #### Modifying Hook Behavior 1. Edit the `.git/hooks/post-commit` file -2. Add additional options to the `penifycli docgen` command +2. Add additional options to the `penify docgen` command 3. Add other commands to run after commit Example of a customized hook: ```bash #!/bin/sh -# This is a post-commit hook generated by penifycli. +# This is a post-commit hook generated by penify. # Automatically generates documentation for changed files after each commit. # Generate documentation -penifycli docgen -gf /path/to/git/repository -t your_api_token +penify docgen -gf /path/to/git/repository -t your_api_token # Additional custom commands echo "Documentation generation complete!" @@ -191,7 +191,7 @@ echo "Documentation generation complete!" # Only generate documentation for commits to the main branch BRANCH=$(git rev-parse --abbrev-ref HEAD) if [ "$BRANCH" = "main" ]; then - penifycli docgen -gf /path/to/git/repository -t your_api_token + penify docgen -gf /path/to/git/repository -t your_api_token fi ``` @@ -200,7 +200,7 @@ fi ```bash #!/bin/sh # Only document Python files in the src directory -penifycli docgen -l src/ -gf /path/to/git/repository -t your_api_token +penify docgen -l src/ -gf /path/to/git/repository -t your_api_token ``` ### Hook Uninstallation @@ -210,7 +210,7 @@ penifycli docgen -l src/ -gf /path/to/git/repository -t your_api_token To remove a hook from the current repository: ```bash -penifycli docgen uninstall-hook +penify docgen uninstall-hook ``` #### Specific Repository Uninstallation @@ -218,7 +218,7 @@ penifycli docgen uninstall-hook To remove a hook from a specific repository: ```bash -penifycli docgen uninstall-hook -l /path/to/repo +penify docgen uninstall-hook -l /path/to/repo ``` #### Manual Hook Removal @@ -246,7 +246,7 @@ Run documentation generation in CI pipelines: ```bash # In your CI script export PENIFY_API_TOKEN=your_api_token -penifycli docgen -l src/ +penify docgen -l src/ ``` ### Batch Documentation @@ -257,7 +257,7 @@ Generate documentation for multiple repositories: # Bash script for batch documentation for repo in repo1 repo2 repo3; do cd /path/to/$repo - penifycli docgen -l . + penify docgen -l . done ``` @@ -267,7 +267,7 @@ Integrate with other Git hooks: ```bash # In .git/hooks/pre-push -penifycli docgen -l src/ +penify docgen -l src/ ``` ### Documenting Release Tags @@ -277,7 +277,7 @@ Generate documentation when creating a release tag: ```bash # Document everything when creating a tag git tag -a v1.0.0 -penifycli docgen -l . # Document entire codebase +penify docgen -l . # Document entire codebase git commit --amend -m "Release v1.0.0 with updated documentation" ``` @@ -286,7 +286,7 @@ git commit --amend -m "Release v1.0.0 with updated documentation" ### Common Issues 1. **"Authentication required"** - - Run `penifycli login` before using documentation features + - Run `penify login` before using documentation features - Check your API token with `cat ~/.penify` 2. **"Permission denied when installing hook"** @@ -313,7 +313,7 @@ For detailed output when running documentation commands: ```bash export PENIFY_DEBUG=1 -penifycli docgen -l src/ +penify docgen -l src/ ``` ### Getting Help @@ -321,7 +321,7 @@ penifycli docgen -l src/ For command-specific help: ```bash -penifycli docgen --help -penifycli docgen install-hook --help -penifycli docgen uninstall-hook --help +penify docgen --help +penify docgen install-hook --help +penify docgen uninstall-hook --help ``` diff --git a/docs/example-workflows.md b/docs/example-workflows.md index cc2a872..70aa3c9 100644 --- a/docs/example-workflows.md +++ b/docs/example-workflows.md @@ -9,13 +9,13 @@ This document demonstrates how to use Penify CLI in real-world development workf First, configure your local LLM for offline operation: ```bash -penifycli config llm +penify config llm ``` Configure your JIRA integration for enhanced commit messages: ```bash -penifycli config jira +penify config jira ``` ### Daily Workflow @@ -24,7 +24,7 @@ penifycli config jira 2. When ready to commit, use Penify to generate a smart commit message: ```bash -penifycli commit +penify commit ``` 3. Review and confirm the generated commit message @@ -43,13 +43,13 @@ penifycli commit Login to Penify to access advanced documentation features: ```bash -penifycli login +penify login ``` Install the Git hook for automatic documentation generation: ```bash -penifycli docgen install-hook +penify docgen install-hook ``` ### Daily Workflow @@ -64,7 +64,7 @@ penifycli docgen install-hook For specific files or folders: ```bash -penifycli docgen -l src/components/authentication +penify docgen -l src/components/authentication ``` ### Benefits @@ -80,7 +80,7 @@ penifycli docgen -l src/components/authentication Ensure you're logged into Penify: ```bash -penifycli login +penify login ``` ### Workflow @@ -88,7 +88,7 @@ penifycli login 1. Before submitting a PR, generate documentation for changed files: ```bash -penifycli docgen +penify docgen ``` 2. Include the generated documentation in your PR @@ -107,7 +107,7 @@ penifycli docgen Generate comprehensive documentation for the entire codebase: ```bash -penifycli docgen -l . +penify docgen -l . ``` ### For New Team Members @@ -115,7 +115,7 @@ penifycli docgen -l . Generate focused documentation for components you're working on: ```bash -penifycli docgen -l src/components/my-feature +penify docgen -l src/components/my-feature ``` ### Benefits @@ -130,10 +130,10 @@ When working with unfamiliar legacy code: ```bash # Document a specific complex file -penifycli docgen -l src/legacy/complex_module.py +penify docgen -l src/legacy/complex_module.py # Document an entire legacy component -penifycli docgen -l src/legacy/old_component +penify docgen -l src/legacy/old_component ``` ### Benefits diff --git a/docs/penify-cli-documentation.md b/docs/penify-cli-documentation.md index 1a22b77..acc4337 100644 --- a/docs/penify-cli-documentation.md +++ b/docs/penify-cli-documentation.md @@ -12,7 +12,7 @@ Penify CLI is a powerful tool for enhancing your development workflow with AI-po ## Installation ```bash -pip install penifycli +pip install penify ``` ## Getting Started @@ -20,7 +20,7 @@ pip install penifycli After installation, you can check the version of Penify CLI: ```bash -penifycli --version +penify --version ``` ## Commands Overview @@ -39,7 +39,7 @@ The `commit` command generates intelligent commit messages using local LLM model #### Usage: ```bash -penifycli commit [options] +penify commit [options] ``` #### Options: @@ -52,23 +52,23 @@ penifycli commit [options] **Basic usage:** ```bash -penifycli commit +penify commit ``` **Provide context for better results:** ```bash -penifycli commit -m "Fixed the login button" +penify commit -m "Fixed the login button" ``` **Generate a detailed commit message and open editor:** ```bash -penifycli commit -e -d +penify commit -e -d ``` #### Requirements: -- Either a local LLM configuration (via `penifycli config llm`) or Penify login -- For JIRA integration, configure JIRA settings (via `penifycli config jira`) +- Either a local LLM configuration (via `penify config llm`) or Penify login +- For JIRA integration, configure JIRA settings (via `penify config jira`) --- @@ -79,7 +79,7 @@ The `config` command helps you configure local LLM settings and JIRA integration #### Usage: ```bash -penifycli config [subcommand] +penify config [subcommand] ``` #### Subcommands: @@ -91,7 +91,7 @@ penifycli config [subcommand] **Configure local LLM:** ```bash -penifycli config llm +penify config llm ``` This opens a web interface to configure: - Model name (e.g., gpt-3.5-turbo, llama2) @@ -100,7 +100,7 @@ This opens a web interface to configure: **Configure JIRA integration:** ```bash -penifycli config jira +penify config jira ``` This opens a web interface to configure: - JIRA URL (e.g., https://your-domain.atlassian.net) @@ -116,7 +116,7 @@ The `login` command authenticates you with Penify for advanced features like cod #### Usage: ```bash -penifycli login +penify login ``` #### What happens: @@ -127,7 +127,7 @@ penifycli login #### Example: ```bash -penifycli login +penify login ``` --- @@ -139,7 +139,7 @@ The `docgen` command generates documentation for your code using Penify's AI ser #### Usage: ```bash -penifycli docgen [options] [subcommand] +penify docgen [options] [subcommand] ``` #### Options: @@ -155,32 +155,32 @@ penifycli docgen [options] [subcommand] **Document current Git diff:** ```bash -penifycli docgen +penify docgen ``` **Document a specific file:** ```bash -penifycli docgen -l src/main.py +penify docgen -l src/main.py ``` **Document an entire folder:** ```bash -penifycli docgen -l src/components +penify docgen -l src/components ``` **Install the Git hook for automatic documentation:** ```bash -penifycli docgen install-hook +penify docgen install-hook ``` **Uninstall the Git hook:** ```bash -penifycli docgen uninstall-hook +penify docgen uninstall-hook ``` #### Requirements: -- Requires login to Penify (`penifycli login`) +- Requires login to Penify (`penify login`) ## Configuration Files diff --git a/penify_hook/commands/doc_commands.py b/penify_hook/commands/doc_commands.py index 5fb3273..e39f9bb 100644 --- a/penify_hook/commands/doc_commands.py +++ b/penify_hook/commands/doc_commands.py @@ -143,7 +143,7 @@ def handle_docgen(args): token = get_token() if not token: - logging.error("Error: Unable to authenticate. Please run 'penifycli login'.") + logging.error("Error: Unable to authenticate. Please run 'penify login'.") sys.exit(1) if args.docgen_subcommand == "install-hook": diff --git a/penify_hook/commands/hook_commands.py b/penify_hook/commands/hook_commands.py index 1a49bfe..8f8110a 100644 --- a/penify_hook/commands/hook_commands.py +++ b/penify_hook/commands/hook_commands.py @@ -3,10 +3,10 @@ HOOK_FILENAME = "post-commit" HOOK_TEMPLATE = """#!/bin/sh -# This is a post-commit hook generated by penifycli. +# This is a post-commit hook generated by penify. # Automatically generates documentation for changed files after each commit. -penifycli docgen -gf {git_folder_path} -t {token} +penify docgen -gf {git_folder_path} -t {token} """ def install_git_hook(location, token): diff --git a/penify_hook/main.py b/penify_hook/main.py index 2f4312f..35c332b 100644 --- a/penify_hook/main.py +++ b/penify_hook/main.py @@ -59,9 +59,9 @@ def main(): if '--version' in sys.argv or '-v' in sys.argv: from importlib.metadata import version try: - print(f"penifycli version {version('penifycli')}") + print(f"penify version {version('penify')}") except: - print("penifycli version 0.2.2") + print("penify version 0.2.2") return 0 # Parse the arguments to determine which command was requested diff --git a/setup.py b/setup.py index 82ff85b..f5de7f8 100644 --- a/setup.py +++ b/setup.py @@ -1,7 +1,7 @@ from setuptools import setup, find_packages setup( - name="penifycli", # Changed from "penifycli" to a more unique name + name="penify", # Changed from "penify" to a more unique name version="0.2.4", packages=['penify_hook'], install_requires=[ @@ -14,7 +14,7 @@ ], entry_points={ "console_scripts": [ - "penifycli=penify_hook.main:main", # Command name remains the same + "penify=penify_hook.main:main", # Command name remains the same ], }, author="Suman Saurabh", @@ -22,7 +22,7 @@ description="A penify cli tool to generate Documentation, Commit-summary.", long_description=open("README.md").read(), long_description_content_type="text/markdown", - url="https://github.com/SingularityX-ai/penifycli", + url="https://github.com/SingularityX-ai/penify", classifiers=[ "Programming Language :: Python :: 3", "License :: OSI Approved :: MIT License", From b5f9473285d388cc6e1d85d07a9b210d2d12c98d Mon Sep 17 00:00:00 2001 From: sumansaurabh Date: Wed, 30 Apr 2025 20:19:10 +0530 Subject: [PATCH 2/2] Bump version to 0.3.0 for release --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index f5de7f8..5b48b93 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ setup( name="penify", # Changed from "penify" to a more unique name - version="0.2.4", + version="0.3.0", packages=['penify_hook'], install_requires=[ "requests",