Skip to content

Commit 3214f13

Browse files
refactor: rename package to python_cli_template
1 parent 13fb156 commit 3214f13

File tree

7 files changed

+21
-21
lines changed

7 files changed

+21
-21
lines changed

β€Ž.github/CONTRIBUTING.mdβ€Ž

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ Pull requests are welcome! By participating in this project, you agree to abide
1717

1818
## Fork
1919

20-
[Fork](https://github.com/remarkablemark/python_package_template/fork) and then clone the repository:
20+
[Fork](https://github.com/remarkablemark/python_cli_template/fork) and then clone the repository:
2121

2222
```sh
2323
# replace <USER> with your username
24-
git clone [email protected]:<USER>/python_package_template.git
24+
git clone [email protected]:<USER>/python_cli_template.git
2525
```
2626

2727
```sh
28-
cd python_package_template
28+
cd python_cli_template
2929
```
3030

3131
## Install
@@ -80,13 +80,13 @@ Write a commit message that follows the [Conventional Commits](https://www.conve
8080
- **ci**: Updates configuration files and scripts for continuous integration
8181
- **docs**: Documentation only changes
8282

83-
Push to your fork and create a [pull request](https://github.com/remarkablemark/python_package_template/compare/).
83+
Push to your fork and create a [pull request](https://github.com/remarkablemark/python_cli_template/compare/).
8484

8585
At this point, wait for us to review your pull request. We'll try to review pull requests within 1-3 business days. We may suggest changes, improvements, and/or alternatives.
8686

8787
Things that will improve the chance that your pull request will be accepted:
8888

89-
- [ ] Write tests that pass [CI](https://github.com/remarkablemark/python_package_template/actions/workflows/test.yml).
89+
- [ ] Write tests that pass [CI](https://github.com/remarkablemark/python_cli_template/actions/workflows/test.yml).
9090
- [ ] Write solid documentation.
9191
- [ ] Write a good [commit message](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit).
9292

@@ -141,7 +141,7 @@ twine upload --repository testpypi dist/*
141141
Install the package:
142142

143143
```sh
144-
pip install --index-url https://test.pypi.org/simple/ --no-deps python_package_template
144+
pip install --index-url https://test.pypi.org/simple/ --no-deps python_cli_template
145145
```
146146

147147
## Release

β€Ž.github/workflows/release-please.ymlβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
id-token: write
3030
environment:
3131
name: pypi
32-
url: https://pypi.org/p/python_package_template
32+
url: https://pypi.org/p/python_cli_template
3333

3434
steps:
3535
- name: Checkout repository

β€ŽREADME.mdβ€Ž

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
# python_package_template
1+
# python_cli_template
22

3-
[![PyPI version](https://badgen.net/pypi/v/python_package_template)](https://pypi.org/project/python_package_template/)
4-
[![test](https://github.com/remarkablemark/python_package_template/actions/workflows/test.yml/badge.svg)](https://github.com/remarkablemark/python_package_template/actions/workflows/test.yml)
5-
[![lint](https://github.com/remarkablemark/python_package_template/actions/workflows/lint.yml/badge.svg)](https://github.com/remarkablemark/python_package_template/actions/workflows/lint.yml)
3+
[![PyPI version](https://badgen.net/pypi/v/python_cli_template)](https://pypi.org/project/python_cli_template/)
4+
[![test](https://github.com/remarkablemark/python_cli_template/actions/workflows/test.yml/badge.svg)](https://github.com/remarkablemark/python_cli_template/actions/workflows/test.yml)
5+
[![lint](https://github.com/remarkablemark/python_cli_template/actions/workflows/lint.yml/badge.svg)](https://github.com/remarkablemark/python_cli_template/actions/workflows/lint.yml)
66

7-
🐍 Python Package Template
7+
🐍 Python CLI Template
88

99
## Install
1010

11-
[Python](https://pypi.org/project/python_package_template/):
11+
[Python](https://pypi.org/project/python_cli_template/):
1212

1313
```sh
14-
pip install python_package_template
14+
pip install python_cli_template
1515
```
1616

1717
## Usage
1818

1919
Print greeting:
2020

2121
```py
22-
from python_package_template import template
22+
from python_cli_template import template
2323

2424
print(template.hello())
2525
```
2626

2727
## License
2828

29-
[MIT](https://github.com/remarkablemark/python_package_template/blob/master/LICENSE)
29+
[MIT](https://github.com/remarkablemark/python_cli_template/blob/master/LICENSE)

β€Žpyproject.tomlβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[project]
2-
name = "python_package_template"
2+
name = "python_cli_template"
33
authors = [
44
{ name="Mark", email="[email protected]" },
55
]
6-
description = "Python Package Template"
6+
description = "Python CLI Template"
77
readme = "README.md"
88
requires-python = ">=3.8"
99
classifiers = [
@@ -29,8 +29,8 @@ test = [
2929
]
3030

3131
[project.urls]
32-
Homepage = "https://github.com/remarkablemark/python_package_template"
33-
Issues = "https://github.com/remarkablemark/python_package_template/issues"
32+
Homepage = "https://github.com/remarkablemark/python_cli_template"
33+
Issues = "https://github.com/remarkablemark/python_cli_template/issues"
3434

3535
[tool.black]
3636
fast = true
File renamed without changes.
File renamed without changes.

β€Žtests/python_package_template/test_template.pyβ€Ž renamed to β€Žtests/python_cli_template/test_template.pyβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from python_package_template.template import hello
1+
from python_cli_template.template import hello
22

33

44
def test_hello():

0 commit comments

Comments
Β (0)