diff --git a/doc/installation.rst b/doc/installation.rst index fe7204ba6..bfce72180 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -103,6 +103,16 @@ If ``python-can`` is already installed, the CANtact backend can be installed sep Additional CANtact documentation is available at `cantact.io `__. +CanViewer +~~~~~~~~~ + +``python-can`` has support for showing a simple CAN viewer terminal application +by running ``python -m can.viewer``. On Windows, this depends on the +`windows-curses library `__ which can +be installed with: + +``python -m pip install "python-can[viewer]"`` + Installing python-can in development mode ----------------------------------------- diff --git a/setup.py b/setup.py index c9defecab..adbd61f91 100644 --- a/setup.py +++ b/setup.py @@ -33,6 +33,9 @@ "gs_usb": ["gs_usb>=0.2.1"], "nixnet": ["nixnet>=0.3.1"], "pcan": ["uptime~=3.0.1"], + "viewer": [ + 'windows-curses;platform_system=="Windows" and platform_python_implementation=="CPython"' + ], } setup( @@ -86,7 +89,6 @@ install_requires=[ "setuptools", "wrapt~=1.10", - 'windows-curses;platform_system=="Windows" and platform_python_implementation=="CPython"', "typing_extensions>=3.10.0.0", 'pywin32;platform_system=="Windows" and platform_python_implementation=="CPython"', 'msgpack~=1.0.0;platform_system!="Windows"',