refactor: rename package to python-cli-template

Author: remarkablemark

.github/CONTRIBUTING.md

@@ -4,15 +4,15 @@ Pull requests are welcome! By participating in this project, you agree to abide
 
 ## Fork
 
-[Fork](https://github.com/remarkablemark/python_cli_template/fork) and then clone the repository:
+[Fork](https://github.com/remarkablemark/python-cli-template/fork) and then clone the repository:
 
 ```sh
 # replace <USER> with your username
-git clone git@github.com:<USER>/python_cli_template.git
+git clone git@github.com:<USER>/python-cli-template.git
 ```
 
 ```sh
-cd python_cli_template
+cd python-cli-template
 ```
 
 ## Install
@@ -62,13 +62,13 @@ Write a commit message that follows the [Conventional Commits](https://www.conve
 - **ci**: Updates configuration files and scripts for continuous integration
 - **docs**: Documentation only changes
 
-Push to your fork and create a [pull request](https://github.com/remarkablemark/python_cli_template/compare/).
+Push to your fork and create a [pull request](https://github.com/remarkablemark/python-cli-template/compare/).
 
 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.
 
 Things that will improve the chance that your pull request will be accepted:
 
-- [ ] Write tests that pass [CI](https://github.com/remarkablemark/python_cli_template/actions/workflows/test.yml).
+- [ ] Write tests that pass [CI](https://github.com/remarkablemark/python-cli-template/actions/workflows/test.yml).
 - [ ] Write solid documentation.
 - [ ] Write a good [commit message](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit).
 
@@ -111,7 +111,7 @@ pipx install . --force
 Test the command:
 
 ```sh
-python_cli_template --help
+python-cli-template --help
 ```
 
 ## Lint
@@ -169,13 +169,13 @@ twine upload --repository testpypi dist/*
 Install the package:
 
 ```sh
-pip install --index-url https://test.pypi.org/simple/ --no-deps python_cli_template
+pip install --index-url https://test.pypi.org/simple/ --no-deps python-cli-template
 ```
 
 Bundle the package with [PyInstaller](https://pyinstaller.org/):
 
 ```sh
-pyinstaller src/python_cli_template/cli.py --name python_cli_template
+pyinstaller src/python-cli-template/cli.py --name python-cli-template
 ```
 
 ## Docs

.github/workflows/docs.yml

@@ -15,7 +15,7 @@ jobs:
         uses: actions/setup-python@v6
         with:
           cache: pip
-          python-version: 3
+          python-version-file: pyproject.toml
 
       - name: Install dependencies
         run: pip install -e .[docs]

.github/workflows/lint.yml

@@ -15,7 +15,7 @@ jobs:
         uses: actions/setup-python@v6
         with:
           cache: pip
-          python-version: 3
+          python-version-file: pyproject.toml
 
       - name: Install dependencies
         run: pip install -e .[lint]

.github/workflows/release.yml

@@ -31,7 +31,7 @@ jobs:
       id-token: write
     environment:
       name: pypi
-      url: https://pypi.org/p/python_cli_template
+      url: https://pypi.org/p/python-cli-template
 
     steps:
       - name: Checkout repository
@@ -40,15 +40,15 @@ jobs:
       - name: Use Python
         uses: actions/setup-python@v6
         with:
-          python-version: 3
+          python-version-file: pyproject.toml
 
       - name: Install build
         run: python -m pip install build
 
       - name: Build package
         run: python -m build
 
-      - name: Publish package to PyPI
+      - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ secrets.PYPI_API_TOKEN }}
@@ -70,33 +70,27 @@ jobs:
       - name: Use Python
         uses: actions/setup-python@v6
         with:
-          python-version: 3
+          python-version-file: pyproject.toml
 
       - name: Install dependencies
         run: pip install -e '.[build]'
 
       - name: Build executable
-        run: pyinstaller src/python_cli_template/cli.py --name python_cli_template --onefile --clean
+        run: pyinstaller src/python_cli_template/cli.py --name python-cli-template --onefile --clean
 
       - name: Compress executable
-        if: matrix.os != 'windows-latest'
-        working-directory: dist
-        run: zip archive.zip python_cli_template
-
-      - name: Compress executable
-        if: matrix.os == 'windows-latest'
-        working-directory: dist
-        run: Compress-Archive -Path python_cli_template.exe -Destination archive.zip
+        shell: bash
+        run: |
+          if [[ $RUNNER_OS == 'Windows' ]]; then
+            7z a -r archive.zip dist
+          else
+            zip -r archive.zip dist
+          fi
 
       - name: Upload Release Artifact
         shell: bash
-        working-directory: dist
         run: |
-          os=${{ matrix.os }}
-          filename=${os%-*}.zip
-          if [[ $filename == 'ubuntu'* ]]; then
-            filename=linux.zip
-          fi
+          filename=$(echo $RUNNER_OS | tr '[:upper:]' '[:lower:]').zip
           mv archive.zip $filename
           gh release upload ${{ needs.release.outputs.tag_name }} $filename
         env:

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
         uses: actions/setup-python@v6
         with:
           cache: pip
-          python-version: 3
+          python-version-file: pyproject.toml
 
       - name: Install dependencies
         run: pip install -e .[test]
@@ -41,7 +41,7 @@ jobs:
         uses: actions/setup-python@v6
         with:
           cache: pip
-          python-version: 3
+          python-version-file: pyproject.toml
 
       - name: Install package
         run: pipx install .
@@ -50,19 +50,19 @@ jobs:
         run: |
           version=$(grep version src/python_cli_template/__init__.py | cut -d'"' -f 2)
           set -e
-          [[ $(python_cli_template --version) == $version ]]
-          [[ $(python_cli_template -v) == $version ]]
+          [[ $(python-cli-template --version) == $version ]]
+          [[ $(python-cli-template -v) == $version ]]
 
       - name: Get help
-        run: python_cli_template --help
+        run: python-cli-template --help
 
   integration:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         command:
-          - python_cli_template
-          - python_cli_template --name test
+          - python-cli-template
+          - python-cli-template --name test
     steps:
       - name: Checkout repository
         uses: actions/checkout@v6
@@ -71,7 +71,7 @@ jobs:
         uses: actions/setup-python@v6
         with:
           cache: pip
-          python-version: 3
+          python-version-file: pyproject.toml
 
       - name: Install package
         run: pipx install .

README.md

@@ -1,8 +1,8 @@
-# python_cli_template
+# python-cli-template
 
-[![PyPI version](https://img.shields.io/pypi/v/python_cli_template)](https://pypi.org/project/python_cli_template/)
-[![codecov](https://codecov.io/gh/remarkablemark/python_cli_template/graph/badge.svg?token=l6pg0nf9aJ)](https://codecov.io/gh/remarkablemark/python_cli_template)
-[![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)
+[![PyPI version](https://img.shields.io/pypi/v/python-cli-template)](https://pypi.org/project/python-cli-template/)
+[![codecov](https://codecov.io/gh/remarkablemark/python-cli-template/graph/badge.svg?token=l6pg0nf9aJ)](https://codecov.io/gh/remarkablemark/python-cli-template)
+[![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)
 
 🐍 Python CLI Template
 
@@ -11,7 +11,7 @@
 Greet a name:
 
 ```sh
-pipx run python_cli_template --name world
+pipx run python-cli-template --name world
 ```
 
 ## Prerequisites
@@ -24,29 +24,29 @@ pipx run python_cli_template --name world
 Install the CLI:
 
 ```sh
-pipx install python_cli_template
+pipx install python-cli-template
 ```
 
 ### `--name`
 
 **Optional**: Name to greet. Defaults to `World`.
 
 ```sh
-python_cli_template --name Alex
+python-cli-template --name Alex
 ```
 
 ### `--version`
 
 Show the program's version number and exit:
 
 ```sh
-python_cli_template --version # python_cli_template -v
+python-cli-template --version # python-cli-template -v
 ```
 
 Show the help message and exit:
 
 ```sh
-python_cli_template --help # python_cli_template -h
+python-cli-template --help # python-cli-template -h
 ```
 
 ## Script
@@ -66,7 +66,7 @@ source .venv/bin/activate
 Install the package:
 
 ```sh
-pip install python_cli_template
+pip install python-cli-template
 ```
 
 Greet a name:
@@ -86,4 +86,4 @@ python script.py
 
 ## License
 
-[MIT](https://github.com/remarkablemark/python_cli_template/blob/master/LICENSE)
+[MIT](https://github.com/remarkablemark/python-cli-template/blob/master/LICENSE)

pyproject.toml

@@ -1,5 +1,5 @@
 [project]
-name = "python_cli_template"
+name = "python-cli-template"
 version = "0.0.0"
 authors = [
     { name="Mark", email="mark@remarkablemark.org" },
@@ -16,10 +16,10 @@ license-files = ["LICEN[CS]E*"]
 dependencies = []
 
 [project.scripts]
-python_cli_template = "python_cli_template.cli:main"
+python-cli-template = "python_cli_template.cli:main"
 
 [project.entry-points."pipx.run"]
-python_cli_template = "python_cli_template.cli:main"
+python-cli-template = "python_cli_template.cli:main"
 
 [project.optional-dependencies]
 build = [
@@ -42,8 +42,8 @@ test = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/remarkablemark/python_cli_template"
-Issues = "https://github.com/remarkablemark/python_cli_template/issues"
+Homepage = "https://github.com/remarkablemark/python-cli-template"
+Issues = "https://github.com/remarkablemark/python-cli-template/issues"
 
 [tool.black]
 fast = true