Format CLI output with rich. (#74)

Author: tobiasraabe

.conda/meta.yaml

@@ -12,6 +12,7 @@ source:
 build:
   noarch: python
   number: 0
+  skip: true  # [py36]
   script: {{ PYTHON }} setup.py install --single-version-externally-managed --record record.txt
   entry_points:
     - pytask = _pytask.cli:cli
@@ -24,15 +25,15 @@ requirements:
     - setuptools
 
   run:
-    - python >=3.6
+    - python
 
     - attrs >=17.4.0
     - click
     - click-default-group
     - networkx
     - pluggy
     - pony >=0.7.13
-    - colorama  # [win]
+    - rich
 
 test:
   imports:

.github/workflows/continuous-integration-workflow.yml

@@ -19,7 +19,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
-        python-version: ['3.6', '3.7', '3.8', '3.9']
+        python-version: ['3.7', '3.8', '3.9']
 
     steps:
       - uses: actions/checkout@v2

.pre-commit-config.yaml

@@ -4,12 +4,20 @@ repos:
     hooks:
     -   id: check-added-large-files
         args: ['--maxkb=25']
+    -   id: check-case-conflict
     -   id: check-merge-conflict
+    -   id: check-vcs-permalinks
     -   id: check-yaml
         exclude: meta.yaml
     -   id: debug-statements
         exclude: (debugging\.py)
     -   id: end-of-file-fixer
+    -   id: fix-byte-order-marker
+    -   id: forbid-new-submodules
+    -   id: mixed-line-ending
+    -   id: no-commit-to-branch
+        args: [--branch, main]
+    -   id: trailing-whitespace
 -   repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.8.0  # Use the ref you want to point at
     hooks:

README.rst

@@ -77,21 +77,14 @@ projects. Its features include:
 .. end-features
 
 
-Why do I need a build system?
------------------------------
-
-Read the `section in the documentation <https://pytask-dev.readthedocs.io/en/latest/
-explanations/why_do_i_need_a_build_system.html>`_ if you do not know or are not
-convinced that you need a build system.
-
-
 Installation
 ------------
 
 .. start-installation
 
-pytask is available on `PyPI <https://pypi.org/project/pytask>`_ and on `Anaconda.org
-<https://anaconda.org/conda-forge/pytask>`_. Install the package with
+pytask is available on `PyPI <https://pypi.org/project/pytask>`_ for Python >= 3.6.1 and
+on `Anaconda.org <https://anaconda.org/conda-forge/pytask>`_ for Python >= 3.7. Install
+the package with
 
 .. code-block:: console
 
@@ -101,6 +94,10 @@ pytask is available on `PyPI <https://pypi.org/project/pytask>`_ and on `Anacond
 
     $ conda install -c conda-forge pytask
 
+Color support is automatically available on non-Windows platforms. On Windows, please,
+use `Windows Terminal <https://github.com/microsoft/terminal>`_ which can be, for
+example, installed via the `Microsoft Store <https://aka.ms/terminal>`_.
+
 .. end-installation
 
 Usage

docs/changes.rst

@@ -6,10 +6,12 @@ chronological order. Releases follow `semantic versioning <https://semver.org/>`
 all releases are available on `PyPI <https://pypi.org/project/pytask>`_ and
 `Anaconda.org <https://anaconda.org/conda-forge/pytask>`_.
 
-
-0.0.14 - 2021-xx-xx
+0.0.14 - 2021-03-23
 -------------------
 
+- :gh:`74` reworks the formatting of the command line output by using ``rich``. Due to
+  the new dependency, support for pytask with Python <3.6.1 on PyPI and with Python <3.7
+  on Anaconda will end.
 - :gh:`76` fixes :gh:`75` which reports a bug when a closest ancestor cannot be found to
   shorten node names in the CLI output. Instead a common ancestor is used.
 

docs/explanations/index.rst

@@ -7,6 +7,5 @@ systems in general as well as its design.
 .. toctree::
    :maxdepth: 1
 
-   why_do_i_need_a_build_system
    build_systems
    pluggy

docs/explanations/why_do_i_need_a_build_system.rst

@@ -14,12 +14,7 @@ Features
    :end-before: end-features
 
 
-Installation
-------------
-
-.. include:: ../README.rst
-   :start-after: start-installation
-   :end-before: end-installation
+To install pytask, follow this :doc:`tutorial <tutorials/how_to_install>`.
 
 
 Documentation

docs/index.rst

@@ -1,8 +1,9 @@
 channels:
   - conda-forge
+  - nodefaults
 
 dependencies:
-  - python >= 3.6
+  - python >= 3.7
   - pip
   - furo
   - ipython
@@ -22,6 +23,7 @@ dependencies:
   - pluggy
   - pony >=0.7.13
   - pexpect
+  - rich
 
   - pip:
     - -e ../

docs/rtd_environment.yml

@@ -0,0 +1,6 @@
+How to install pytask
+=====================
+
+.. include:: ../../README.rst
+   :start-after: start-installation
+   :end-before: end-installation