Skip to content

Commit 6b7be69

Browse files
author
aliyaman
committed
hotfix
1 parent f503436 commit 6b7be69

File tree

4 files changed

+14
-15
lines changed

4 files changed

+14
-15
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Checklogs Generator
2-
Hey! This Package is a CLI package that creates automatic checklogs that supports [Conventional Commits.](https://www.conventionalcommits.org/en/v1.0.0/)
1+
# Changelogs Generator
2+
Hey! This Package is a [changelogs-cli](https://pypi.org/project/changelogs-cli/) package that creates automatic changelogs that supports [Conventional Commits.](https://www.conventionalcommits.org/en/v1.0.0/)
33
Since we use Bitbucket, we needed something like this and I wanted to share it publicly in case you need it too.
44

55
# Emoji Support
@@ -19,8 +19,7 @@ If comments comply with conventional commit rules, they are supported with emoji
1919

2020
# Installing
2121

22-
pip install checklogs
23-
https://pypi.org/project/checklogs/
22+
pip install changelogs-cli
2423

2524
# Example
2625

@@ -30,16 +29,16 @@ Example;
3029
cd /home/repository/
3130

3231
Example usage is as follows.
33-
checklogs example/commits/ (this should be commit link to show reference on checklogs md.)
32+
changelogs example/commits/ (this should be commit link to show reference on changelogs md.)
3433

3534

3635
# Demo
3736

3837
i will use this repo for example ; https://github.com/qoomon/git-conventional-commits
3938

40-
<img src="https://raw.githubusercontent.com/AliYmn/checklogs/master/images/ex1.png">
39+
<img src="https://raw.githubusercontent.com/AliYmn/changelogs/master/images/ex1.png">
4140

42-
<img src="https://raw.githubusercontent.com/AliYmn/checklogs/master/images/ex2.png">
41+
<img src="https://raw.githubusercontent.com/AliYmn/changelogs/master/images/ex2.png">
4342

4443
---
4544

checklogs/src.py renamed to changelogs/src.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def getLogs(self):
6565
f.write(self.replace_commits(commit))
6666
previous_tag = tag
6767
f.close()
68-
text = "check logs created successfully."
68+
text = "changelogs.md created successfully."
6969
print('\033[91m'+'result: ' + '\033[92m', text)
7070

7171

@@ -75,4 +75,4 @@ def main():
7575
logs = ChangeLogs(url)
7676
logs.getLogs()
7777
else:
78-
print("Please write commit link : checklogs link")
78+
print("Please write commit link : changelogs link")

setup.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@
1010
README = f.read()
1111

1212
setup(
13-
name="checklogs",
14-
version="2.0.3",
13+
name="changelogs-cli",
14+
version="3.0.0",
1515
author="Ali Yaman",
1616
author_email="aliymn.db@gmail.com",
1717
description="Generates git changelog for Conventional Commits",
1818
license="MIT",
1919
long_description_content_type="text/markdown",
2020
long_description=README,
2121
keywords="Generates git changelog for Conventional Commits",
22-
packages=['checklogs'],
23-
url='https://github.com/AliYmn/checklogs',
24-
download_url='https://github.com/AliYmn/checklogs',
22+
packages=['changelogs'],
23+
url='https://github.com/AliYmn/changelogs',
24+
download_url='https://github.com/AliYmn/changelogs',
2525
install_requires=[],
2626
include_package_data=True,
2727
zip_safe=False,
@@ -45,5 +45,5 @@
4545
'Programming Language :: Python :: 3.11',
4646
'Programming Language :: Python :: 3.12',
4747
],
48-
entry_points={'console_scripts': ['checklogs=checklogs.src:main']},
48+
entry_points={'console_scripts': ['changelogs=changelogs.src:main']},
4949
)

0 commit comments

Comments
 (0)