Merge pull request #52 from bckohan/v1.1.x

Merge V1.1.1 changes.

Author: bckohan

.github/workflows/lint.yml

@@ -43,21 +43,24 @@ jobs:
         run: |
           poetry config virtualenvs.in-project true
           poetry run pip install --upgrade pip
-          poetry install
+          poetry install -E rich
           poetry run pip install -U "django~=${{ matrix.django-version }}"
+      # - name: Setup tmate session
+      #   uses: mxschmitt/action-tmate@v3
+      #   with:
+      #     detached: true
+      #   timeout-minutes: 60
       - name: Run Static Analysis
         run: |
           source .venv/bin/activate
           isort django_typer --check
           black django_typer --check
           pylint django_typer
           mypy django_typer
+          pyright
           poetry check
           pip check
           python -m readme_renderer ./README.md -o /tmp/README.html
           cd ./doc
           doc8 --ignore-path build --max-line-length 100
           echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
-
-      # - name: Run pyright
-      #   uses: jakebailey/pyright-action@v2

CONTRIBUTING.md

@@ -0,0 +1,91 @@
+[Poetry]: https://python-poetry.org/
+[Pylint]: https://www.pylint.org/
+[isort]: https://pycqa.github.io/isort/
+[mypy]: http://mypy-lang.org/
+[django-pytest]: https://pytest-django.readthedocs.io/en/latest/
+[pytest]: https://docs.pytest.org/en/stable/
+[Sphinx]: https://www.sphinx-doc.org/en/master/
+[readthedocs]: https://readthedocs.org/
+[me]: https://github.com/bckohan
+[black]: https://black.readthedocs.io/en/stable/
+[pyright]: https://github.com/microsoft/pyright
+
+# Contributing
+
+Contributions are encouraged! Please use the issue page to submit feature
+requests or bug reports. Issues with attached PRs will be given priority and
+have a much higher likelihood of acceptance. Please also open an issue and
+associate it with any submitted PRs. That said, the aim is to keep this library
+as lightweight as possible. Only features with broad-based use cases will be
+considered.
+
+We are actively seeking additional maintainers. If you're interested, please
+[contact me](https://github.com/bckohan).
+
+## Installation
+
+`django-typer` uses [Poetry](https://python-poetry.org/) for environment, package, and dependency
+management:
+
+```shell
+poetry install
+```
+
+## Documentation
+
+`django-typer` documentation is generated using [Sphinx](https://www.sphinx-doc.org/en/master/) with the
+[readthedocs](https://readthedocs.org/) theme. Any new feature PRs must provide updated documentation for
+the features added. To build the docs run doc8 to check for formatting issues
+then run Sphinx:
+
+```bash
+cd ./doc
+poetry run doc8 --ignore-path build --max-line-length 100
+poetry run make html
+```
+
+## Static Analysis
+
+`django-typer` uses [Pylint](https://www.pylint.org/) for Python linting and [mypy](http://mypy-lang.org/) and [pyright](https://github.com/microsoft/pyright) for static type
+checking. Header imports are also standardized using [isort](https://pycqa.github.io/isort/) and formatting is
+done with [black](https://black.readthedocs.io/en/stable/). Before any PR is accepted the following must be run, and
+static analysis tools should not produce any errors or warnings. Disabling
+certain errors or warnings where justified is acceptable:
+
+```bash
+poetry run isort django_typer
+poetry run black django_typer
+poetry run pylint django_typer
+poetry run mypy django_typer
+pyright
+poetry check
+poetry run pip check
+poetry run python -m readme_renderer ./README.md
+```
+
+## Running Tests
+
+`django-typer` is set up to use [pytest](https://docs.pytest.org/en/stable/) to run unit tests. All the tests are
+housed in `django_typer/tests/tests.py`. Before a PR is accepted, all tests
+must be passing and the code coverage must be at 100%. A small number of
+exempted error handling branches are acceptable.
+
+To run the full suite:
+
+```shell
+poetry run pytest
+```
+
+To run a single test, or group of tests in a class:
+
+```shell
+poetry run pytest <path_to_tests_file>::ClassName::FunctionName
+```
+
+For instance, to run all tests in BasicTests, and then just the
+test_call_command test you would do:
+
+```shell
+poetry run pytest django_typer/tests/tests.py::BasicTests
+poetry run pytest django_typer/tests/tests.py::BasicTests::test_call_command
+```

CONTRIBUTING.rst

@@ -1,7 +1,7 @@
 # django-typer
 
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![PyPI version](https://badge.fury.io/py/django-typer.svg)](https://pypi.python.org/pypi/django-typer/)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/django-typer.svg)](https://pypi.python.org/pypi/django-typer/)
 [![PyPI djversions](https://img.shields.io/pypi/djversions/django-typer.svg)](https://pypi.org/project/django-typer/)

README.md

@@ -114,7 +114,7 @@
     from typing import ParamSpec
 
 
-VERSION = (1, 1, 0)
+VERSION = (1, 1, 1)
 
 __title__ = "Django Typer"
 __version__ = ".".join(str(i) for i in VERSION)
@@ -1210,8 +1210,8 @@ class TyperCommandMeta(type):
     """
 
     style: ColorStyle
-    stdout: t.IO[str]
-    stderr: t.IO[str]
+    stdout: BaseOutputWrapper
+    stderr: BaseOutputWrapper
     requires_system_checks: t.Union[t.Sequence[str], str]
     suppressed_base_arguments: t.Optional[t.Iterable[str]]
     typer_app: Typer

django_typer/__init__.py

@@ -20,7 +20,8 @@
 
 patch.apply()
 
-rich: t.Union[ModuleType, None] = None
+rich: t.Optional[ModuleType]
+traceback: t.Optional[ModuleType]
 
 try:
     import sys
@@ -30,7 +31,12 @@
     from typer import main as typer_main
 
     tb_config = traceback_config()
-    if rich and isinstance(tb_config, dict) and not tb_config.get("no_install", False):
+    if (
+        rich
+        and traceback
+        and isinstance(tb_config, dict)
+        and not tb_config.get("no_install", False)
+    ):
         # install rich tracebacks if we've been configured to do so (default)
         no_color = "NO_COLOR" in os.environ
         force_color = "FORCE_COLOR" in os.environ
@@ -60,7 +66,8 @@
         # installed rich one - we patch it here to make sure!
         typer_main._original_except_hook = sys.excepthook
 except ImportError:
-    pass
+    rich = None
+    traceback = None
 
 
 @register("settings")

django_typer/apps.py

@@ -2,6 +2,12 @@
 Change Log
 ==========
 
+v1.1.1
+======
+
+* Implemented `Fix pyright type checking and add to CI <https://github.com/bckohan/django-typer/issues/51>`_
+* Implemented `Convert CONTRIBUTING.rst to markdown <https://github.com/bckohan/django-typer/issues/50>`_
+
 v1.1.0
 ======
 

doc/source/changelog.rst

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-typer"
-version = "1.1.0"
+version = "1.1.1"
 description = "Use Typer to define the CLI for your Django management commands."
 authors = ["Brian Kohan <[email protected]>"]
 license = "MIT"
@@ -88,6 +88,7 @@ scipy = [
 ]
 django-stubs = "^4.2.7"
 pexpect = "^4.9.0"
+pyright = "^1.1.357"
 
 [tool.poetry.extras]
 rich = ["rich"]