Skip to content

Commit 64a807f

Browse files
committed
fix(workflow): add package name availability check in PyPI workflow and update README for clarity
1 parent cdb21e1 commit 64a807f

3 files changed

Lines changed: 21 additions & 8 deletions

File tree

.github/workflows/pypi.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,19 @@ jobs:
1818
run: |
1919
python -m pip install --upgrade pip
2020
python -m pip install setuptools wheel twine
21+
- name: Check package name availability
22+
run: |
23+
echo "Checking if package name is available on PyPI..."
24+
PACKAGE_NAME=$(python -c "from setuptools import setup; import sys; sys.argv=[sys.argv[0]]; __file__='setup.py'; exec(open('setup.py').read()); print(locals()['name'])")
25+
if pip search $PACKAGE_NAME 2>/dev/null | grep -q "^$PACKAGE_NAME "; then
26+
echo "WARNING: Package name '$PACKAGE_NAME' seems to be already taken on PyPI"
27+
echo "Please consider updating the name in setup.py before proceeding"
28+
# Uncomment next line to fail the build if you want strict enforcement
29+
# exit 1
30+
else
31+
echo "Package name '$PACKAGE_NAME' appears to be available"
32+
fi
33+
continue-on-error: true
2134
- name: Build and publish
2235
env:
2336
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Penify CLI
1+
# Penify CLI Tool
22

3-
Penify CLI is a command-line tool for managing Git commits, generating documentation, and streamlining the development workflow. It provides AI-powered commit message generation, JIRA integration, and documentation tools.
3+
A CLI tool to generate Documentation, Commit-summary, and more.
44

55
## Installation
66

7-
You can install Penify CLI using pip:
7+
Install from PyPI:
88

99
```bash
1010
pip install penifycli

setup.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
from setuptools import setup, find_packages
22

33
setup(
4-
name="penifycli",
5-
version="1.0.0", # Increment the version number
6-
packages=['penify_hook'], # Explicitly include the penify_hook package
4+
name="penify-cli", # Changed from "penifycli" to a more unique name
5+
version="1.0.0",
6+
packages=['penify_hook'],
77
install_requires=[
88
"requests",
99
"tqdm",
1010
"GitPython",
1111
"colorama",
1212
"litellm",
13-
"jira" # Add JIRA as a dependency
13+
"jira"
1414
],
1515
entry_points={
1616
"console_scripts": [
17-
"penifycli=penify_hook.main:main",
17+
"penifycli=penify_hook.main:main", # Command name remains the same
1818
],
1919
},
2020
author="Suman Saurabh",

0 commit comments

Comments
 (0)