From 7db5f112eebf5b031cec3ef147b9b6e6af9b8e7d Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Sat, 25 Jan 2025 11:17:17 -0500 Subject: [PATCH] Update CONTRIBUTING.md and Pipfile for removed dependency --- .github/CONTRIBUTING.md | 29 ++++++++++++++--------------- Pipfile | 1 - 2 files changed, 14 insertions(+), 16 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7def0a6c..812c7153 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -63,21 +63,20 @@ The tables below list all prerequisites along with the minimum required version #### Additional prerequisites for developing cmd2 -| Prerequisite | Minimum Version | Purpose | -| ------------------------------------------------------------------------------------------ | --------------- | --------------------------------- | -| [codecov](http://doc.pytest.org/en/latest/) | `2.1.13` | Cover coverage reporting | -| [invoke](https://www.pyinvoke.org/) | `2.2.0` | Command automation | -| [griffe_typingdoc](https://github.com/mkdocstrings/griffe-typingdoc) | `0.2.7` | mkdocstrings extension for typing | -| [mypy](https://mypy-lang.org/) | `1.13.0` | Static type checker | -| [pytest](https://docs.pytest.org/en/stable/) | `3.0.6` | Unit and integration tests | -| [pytest-cov](http://doc.pytest.org/en/latest/) | `6.0.0` | Pytest code coverage | -| [pytest-mock](https://pypi.org/project/pytest-mock/) | `3.14.0` | Pytest mocker fixture | -| [mkdocs-include-markdown-plugin](https://pypi.org/project/mkdocs-include-markdown-plugin/) | `7.1.2` | MkDocs Plugin include MkDn | -| [mkdocs-macros-plugin](https://mkdocs-macros-plugin.readthedocs.io/) | `1.3.7` | MkDocs Plugin for macros | -| [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) | `9.5.49` | Documentation | -| [mkdocstrings[python]](https://mkdocstrings.github.io/) | `0.27.0` | MkDocs Plugin for Python AutoDoc | -| [ruff](https://github.com/astral-sh/ruff) | `0.7.3` | Fast linter and formatter | -| [uv](https://github.com/astral-sh/uv) | `0.5.1` | Python package management | +| Prerequisite | Minimum Version | Purpose | +| ------------------------------------------------------------------------------------------ | --------------- | -------------------------------- | +| [codecov](http://doc.pytest.org/en/latest/) | `2.1.13` | Cover coverage reporting | +| [invoke](https://www.pyinvoke.org/) | `2.2.0` | Command automation | +| [mypy](https://mypy-lang.org/) | `1.13.0` | Static type checker | +| [pytest](https://docs.pytest.org/en/stable/) | `3.0.6` | Unit and integration tests | +| [pytest-cov](http://doc.pytest.org/en/latest/) | `6.0.0` | Pytest code coverage | +| [pytest-mock](https://pypi.org/project/pytest-mock/) | `3.14.0` | Pytest mocker fixture | +| [mkdocs-include-markdown-plugin](https://pypi.org/project/mkdocs-include-markdown-plugin/) | `7.1.2` | MkDocs Plugin include MkDn | +| [mkdocs-macros-plugin](https://mkdocs-macros-plugin.readthedocs.io/) | `1.3.7` | MkDocs Plugin for macros | +| [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) | `9.5.49` | Documentation | +| [mkdocstrings[python]](https://mkdocstrings.github.io/) | `0.27.0` | MkDocs Plugin for Python AutoDoc | +| [ruff](https://github.com/astral-sh/ruff) | `0.7.3` | Fast linter and formatter | +| [uv](https://github.com/astral-sh/uv) | `0.5.1` | Python package management | If Python is already installed in your machine, run the following commands to validate the versions: diff --git a/Pipfile b/Pipfile index 0b7b1220..b0ba2c0c 100644 --- a/Pipfile +++ b/Pipfile @@ -14,7 +14,6 @@ cmd2 = { editable = true, path = "." } cmd2_ext_test = { editable = true, path = "plugins/ext_test" } codecov = "*" gnureadline = { version = "*", sys_platform = "== 'darwin'" } -griffe-typingdoc = "*" invoke = "*" ipython = "*" mypy = "*"