Skip to content

Commit a917203

Browse files
refactor: rename package to python-package-template
1 parent 537998e commit a917203

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

.github/CONTRIBUTING.md

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

55
## Fork
66

7-
[Fork](https://github.com/remarkablemark/python_package_template/fork) and then clone the repository:
7+
[Fork](https://github.com/remarkablemark/python-package-template/fork) and then clone the repository:
88

99
```sh
1010
# replace <USER> with your username
11-
git clone git@github.com:<USER>/python_package_template.git
11+
git clone git@github.com:<USER>/python-package-template.git
1212
```
1313

1414
```sh
15-
cd python_package_template
15+
cd python-package-template
1616
```
1717

1818
## Install
@@ -62,13 +62,13 @@ Write a commit message that follows the [Conventional Commits](https://www.conve
6262
- **ci**: Updates configuration files and scripts for continuous integration
6363
- **docs**: Documentation only changes
6464

65-
Push to your fork and create a [pull request](https://github.com/remarkablemark/python_package_template/compare/).
65+
Push to your fork and create a [pull request](https://github.com/remarkablemark/python-package-template/compare/).
6666

6767
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.
6868

6969
Things that will improve the chance that your pull request will be accepted:
7070

71-
- [ ] Write tests that pass [CI](https://github.com/remarkablemark/python_package_template/actions/workflows/test.yml).
71+
- [ ] Write tests that pass [CI](https://github.com/remarkablemark/python-package-template/actions/workflows/test.yml).
7272
- [ ] Write solid documentation.
7373
- [ ] Write a good [commit message](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit).
7474

@@ -157,7 +157,7 @@ twine upload --repository testpypi dist/*
157157
Install the package:
158158

159159
```sh
160-
pip install --index-url https://test.pypi.org/simple/ --no-deps python_package_template
160+
pip install --index-url https://test.pypi.org/simple/ --no-deps python-package-template
161161
```
162162

163163
## Docs

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
id-token: write
3131
environment:
3232
name: pypi
33-
url: https://pypi.org/p/python_package_template
33+
url: https://pypi.org/p/python-package-template
3434

3535
steps:
3636
- name: Checkout repository
@@ -47,7 +47,7 @@ jobs:
4747
- name: Build package
4848
run: python -m build
4949

50-
- name: Publish package to PyPI
50+
- name: Publish to PyPI
5151
uses: pypa/gh-action-pypi-publish@release/v1
5252
with:
5353
password: ${{ secrets.PYPI_API_TOKEN }}

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# python_package_template
1+
# python-package-template
22

3-
[![PyPI version](https://img.shields.io/pypi/v/python_package_template)](https://pypi.org/project/python_package_template/)
4-
[![codecov](https://codecov.io/gh/remarkablemark/python_package_template/graph/badge.svg?token=A5tAkYLEAw)](https://codecov.io/gh/remarkablemark/python_package_template)
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://img.shields.io/pypi/v/python-package-template)](https://pypi.org/project/python-package-template/)
4+
[![codecov](https://codecov.io/gh/remarkablemark/python-package-template/graph/badge.svg?token=A5tAkYLEAw)](https://codecov.io/gh/remarkablemark/python-package-template)
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)
66

77
🐍 Python Package Template
88

@@ -15,7 +15,7 @@
1515
Install the package:
1616

1717
```sh
18-
pip install python_package_template
18+
pip install python-package-template
1919
```
2020

2121
## Usage
@@ -30,4 +30,4 @@ print(hello())
3030

3131
## License
3232

33-
[MIT](https://github.com/remarkablemark/python_package_template/blob/master/LICENSE)
33+
[MIT](https://github.com/remarkablemark/python-package-template/blob/master/LICENSE)

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[project]
2-
name = "python_package_template"
2+
name = "python-package-template"
33
version = "0.0.0"
44
authors = [
55
{ name="Mark", email="mark@remarkablemark.org" },
@@ -35,8 +35,8 @@ test = [
3535
]
3636

3737
[project.urls]
38-
Homepage = "https://github.com/remarkablemark/python_package_template"
39-
Issues = "https://github.com/remarkablemark/python_package_template/issues"
38+
Homepage = "https://github.com/remarkablemark/python-package-template"
39+
Issues = "https://github.com/remarkablemark/python-package-template/issues"
4040

4141
[tool.black]
4242
fast = true

0 commit comments

Comments
 (0)