rename shell command to pyo3-stubgen (#11)

- cli is now `pyo3-stubgen MODULENAME OUTPUTLOCATION` to avoid conflicts when mypy is also installed
- fixed a bug in optional dependencies `[cov]`

Author: MusicalNinjaDad

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.3.0 - rename shell command to `pyo3-stubgen`
+
+- cli is now `pyo3-stubgen MODULENAME OUTPUTLOCATION` to avoid conflicts when mypy is also installed
+
 ## v0.2.0 - command line interface
 
 - added a cli `stubgen MODULENAME OUTPUTLOCATION`

README.md

@@ -27,10 +27,10 @@ Install via pip:
 Easiest from the command line:
 
 ```sh
-(.venv)/projectroot$ stubgen MODULENAME OUTPUTLOCATION
+(.venv)/projectroot$ pyo3-stubgen MODULENAME OUTPUTLOCATION
 ```
 
-See `stubgen --help` for more details
+See `pyo3-stubgen --help` for more details
 
 Alternatively via the python API. See [the docs](https://musicalninjas.github.io/pyo3-stubgen) for more details.
 

__pyversion__

@@ -1 +1 @@
-0.2.0
+0.3.0

docs/index.md

@@ -26,10 +26,10 @@ Install via pip:
 Easiest from the command line:
 
 ```sh
-(.venv)/projectroot$ stubgen MODULENAME OUTPUTLOCATION
+(.venv)/projectroot$ pyo3-stubgen MODULENAME OUTPUTLOCATION
 ```
 
-??? tip "`stubgen --help`"
+??? tip "`pyo3-stubgen --help`"
     ```text
     Generate a `.pyi` file for MODULENAME and store it under the project root OUTPUTLOCATION.
 
@@ -45,11 +45,14 @@ Easiest from the command line:
 
     Example:
 
-      `stubgen pypkg.rustlib python` creates `./python/pypkg/rustlib.pyi`
+      `pyo3-stubgen pypkg.rustlib python` creates `./python/pypkg/rustlib.pyi`
     ```
 
 Alternatively via the python API. See [the docs](https://musicalninjas.github.io/pyo3-stubgen) for more details.
 
+??? note "Changes"
+    - v0.3.0: renamed shell command to `pyo3-stubgen`
+
 ## Issues, Bugs, Ideas
 
 Please contribute on github [MusicalNinjas/pyo3-stubgen](https://github.com/MusicalNinjas/pyo3-stubgen).

pyo3_stubgen/generate.py

@@ -98,6 +98,6 @@ def _stubgen(modulename: str, outputlocation: Path) -> None:  # noqa: D417
 
     Example:
 
-      `stubgen pypkg.rustlib python` creates `./python/pypkg/rustlib.pyi`
+      `pyo3-stubgen pypkg.rustlib python` creates `./python/pypkg/rustlib.pyi`
     """  # noqa: D412
     genfile(modulename, outputlocation)

pyproject.toml

@@ -28,7 +28,7 @@
     version = { file = "__pyversion__" }
 
 [project.scripts]
-    stubgen = "pyo3_stubgen:generate._stubgen"
+    pyo3-stubgen = "pyo3_stubgen:generate._stubgen"
 
 # ===========================
 #       Build, package
@@ -47,7 +47,7 @@
 [project.optional-dependencies]
     lint = ["ruff"]
     test = ["pytest", "pytest-doctest-mkdocstrings"]
-    cov = ["pyigen[test]", "pytest-cov"]
+    cov = ["pyo3-stubgen[test]", "pytest-cov"]
     doc = ["black", "mkdocs", "mkdocstrings[python]", "mkdocs-material"]
     dev = ["pyo3-stubgen[lint,test,cov,doc]"]