Skip to content

Commit 8d832f1

Browse files
committed
chore: Update Penify CLI description in setup.py
1 parent 3cf45dc commit 8d832f1

2 files changed

Lines changed: 31 additions & 12 deletions

File tree

README.md

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Penify CLI
22

3-
Penify CLI is a command-line tool for managing Git hooks and generating documentation. It provides functionality to install and uninstall Git post-commit hooks, generate documentation for files or folders, and perform Git commits with automated message generation.
3+
Penify CLI is a command-line tool for managing Git hooks, generating documentation, and streamlining the development workflow. It provides functionality to install and uninstall Git post-commit hooks, generate documentation for files or folders, perform Git commits with automated message generation, and manage authentication.
44

55
## Installation
66

@@ -14,16 +14,25 @@ pip install penify-cli
1414

1515
Penify CLI provides several subcommands for different functionalities:
1616

17+
### Login
18+
19+
To log in and obtain an API token:
20+
21+
```bash
22+
penify-cli login
23+
```
24+
25+
This command will open a browser window for authentication. After successful login, the API key will be saved locally for future use.
26+
1727
### Install Git Hook
1828

1929
To install the Git post-commit hook:
2030

2131
```bash
22-
penify-cli install-hook -l /path/to/git/repo -t your_api_token
32+
penify-cli install-hook -l /path/to/git/repo
2333
```
2434

2535
- `-l, --location`: The path to the Git repository where you want to install the hook.
26-
- `-t, --token`: Your API token for authentication. If not provided, the tool will look for the `PENIFY_API_TOKEN` environment variable.
2736

2837
### Uninstall Git Hook
2938

@@ -40,33 +49,39 @@ penify-cli uninstall-hook -l /path/to/git/repo
4049
To generate documentation for files or folders:
4150

4251
```bash
43-
penify-cli doc-gen -t your_api_token [options]
52+
penify-cli doc-gen [options]
4453
```
4554

4655
Options:
47-
- `-t, --token`: Your API token for authentication. If not provided, the tool will look for the `PENIFY_API_TOKEN` environment variable.
4856
- `-fl, --file_path`: Path to a specific file for which to generate documentation.
4957
- `-cf, --complete_folder_path`: Path to a folder for which to generate documentation for all files.
5058
- `-gf, --git_folder_path`: Path to a Git repository to generate documentation for modified files. Defaults to the current directory.
5159

52-
Note: If you want to automate API Documentation, Architecture Documentation, Code Documentation, Pull Request Documentation and need a demo. Send message in our support channel [Discord](https://discord.gg/wqrc8JeV)
53-
5460
### Commit Code
5561

5662
To commit code with an automatically generated commit message:
5763

5864
```bash
59-
penify-cli commit -gf /path/to/git/repo -t your_api_token [-m "Optional message"] [-e True/False]
65+
penify-cli commit -gf /path/to/git/repo [-m "Optional message"] [-e True/False]
6066
```
6167

6268
- `-gf, --git_folder_path`: Path to the Git repository. Defaults to the current directory.
63-
- `-t, --token`: Your API token for authentication. If not provided, the tool will look for the `PENIFY_API_TOKEN` environment variable.
6469
- `-m, --message`: Optional commit message. If not provided, a default message will be used.
6570
- `-e, --terminal`: Set to "True" to open the terminal for editing the commit message. Defaults to "False".
6671

72+
## Authentication
73+
74+
Penify CLI uses an API token for authentication. The token is obtained and used in the following priority:
75+
76+
1. Command-line argument: `-t` or `--token`
77+
2. Environment variable: `PENIFY_API_TOKEN`
78+
3. Stored credentials: `~/.penify` file (created after successful login)
79+
80+
If no token is available, you'll be prompted to log in or provide a token.
81+
6782
## Environment Variables
6883

69-
- `PENIFY_API_TOKEN`: You can set this environment variable with your API token to avoid passing it as an argument each time. Here is the [tutorial](https://docs.penify.dev/docs/Creating-API-Keys-in-Penify.html) on setting env variables
84+
- `PENIFY_API_TOKEN`: You can set this environment variable with your API token to avoid passing it as an argument each time.
7085

7186
## Development
7287

@@ -96,4 +111,8 @@ Contributions are welcome! Please feel free to submit a Pull Request.
96111

97112
## Issues
98113

99-
If you encounter any problems or have suggestions, please file an issue on the [GitHub repository](https://github.com/SingularityX-ai/penify-cli/issues).
114+
If you encounter any problems or have suggestions, please file an issue on the [GitHub repository](https://github.com/SingularityX-ai/penify-cli/issues).
115+
116+
## Support
117+
118+
For automated API Documentation, Architecture Documentation, Code Documentation, Pull Request Documentation, or if you need a demo, please join our [Discord support channel](https://discord.gg/wqrc8JeV).

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
setup(
44
name="penify-cli",
5-
version="0.1.2", # Increment the version number
5+
version="0.1.3", # Increment the version number
66
packages=['penify_hook'], # Explicitly include the penify_hook package
77
install_requires=[
88
"requests",

0 commit comments

Comments
 (0)