Use ruff for repository linting instead of replacing pylint_notebook

Co-authored-by: AlexeyKozhevin <[email protected]>

Author: Copilot

.github/workflows/status.yml

@@ -11,8 +11,8 @@ jobs:
     steps:
     - uses: actions/checkout@v1
 
-    - name: Update pylint
-      run: pip3 install -U pylint
+    - name: Install ruff
+      run: pip3 install -U ruff
 
-    - name: Check pylint
-      run: pylint -rn --rcfile pylintrc nbtools
+    - name: Check ruff
+      run: ruff check nbtools

docs/user_guide/nbtools.library.rst

@@ -5,24 +5,24 @@ Jupyter Notebooks: linting and execution
 Other than `nbstat / nbwatch` monitoring utilities, this library provides a few useful tools for working with notebooks and GPUs.
 
 
-ruff_notebook
-*************
+pylint_notebook
+***************
 
-Function that checks for errors in Jupyter Notebooks with Python code using `ruff <https://docs.astral.sh/ruff/>`_, a fast Python linter. It tries to enforce a coding standard, looks for code smells, and can detect various issues including imports, formatting, and potential bugs.
+Shamelessly taken from `pylint page <https://pylint.pycqa.org/en/latest/>`_
 
-Using it is as easy as:
+Function that checks for errors in Jupyter Notebooks with Python code, tries to enforce a coding standard and looks for code smells. It can also look for certain type errors, it can recommend suggestions about how particular blocks can be refactored and can offer you details about the code's complexity.
 
-.. code-block:: python
+Using it as easy as:
 
-    from nbtools import ruff_notebook
-    ruff_notebook(path_to_ipynb,               # If not provided, use path to the current notebook
-                  ignore=['E402', 'F401'],     # Ignore specified ruff rule codes. Can be a list.
-                  config='path/to/ruff.toml')  # Custom ruff configuration file
+.. code-block:: python
 
-For backward compatibility, ``pylint_notebook`` is still available as an alias to ``ruff_notebook``.
+    from nbtools import pylint_notebook
+    pylint_notebook(path_to_ipynb,             # If not provided, use path to the current notebook
+                    disable='invalid-name',    # Disable specified Pylint checks. Can be a list.
+                    enable='import-error')     # Enable  specified Pylint checks. Can be a list.
 
 
-Under the hood, it converts `.ipynb` notebook to `.py` script, creates a custom `ruff.toml` configuration, runs `ruff` and removes all temporary files. Learn more about its usage in the [tutorial.](tutorials/NBstat.ipynb)
+Under the hood, it converts `.ipynb` notebook to `.py` script, creates a custom `.pylintrc` configuration, runs the `pylint` and removes all temporary files. Learn more about its usage in the [tutorial.](tutorials/NBstat.ipynb)
 
 exec_notebook
 *************

nbtools/__init__.py

@@ -1,6 +1,7 @@
 """ Init file. """
+#pylint: disable=wildcard-import
 from .core import *
 from .exec_notebook import exec_notebook, run_notebook
-from .ruff_notebook import ruff_notebook, pylint_notebook
+from .pylint_notebook import pylint_notebook
 
 __version__ = '0.9.14'

nbtools/ruff_notebook.py

@@ -0,0 +1,28 @@
+[MASTER]
+extension-pkg-whitelist=numpy
+init-hook='import sys; sys.path.append(".")'
+
+[FORMAT]
+max-line-length=120
+max-statements=100
+max-attributes=50
+max-public-methods=50
+max-args=50
+max-locals=50
+max-branches=50
+variable-rgx=(.*[a-z][a-z0-9_]{1,30}|[a-z_])$ # snake_case + single letters
+argument-rgx=(.*[a-z][a-z0-9_]{1,30}|[a-z_])$ # snake_case + single letters
+
+[MESSAGE CONTROL]
+disable=import-error, relative-beyond-top-level, attribute-defined-outside-init, unnecessary-lambda-assignment,
+        consider-iterating-dictionary, possibly-used-before-assignment
+
+[TYPECHECK]
+ignored-modules=numpy, numba
+
+[BASIC]
+class-rgx=[A-Z_][a-zA-Z0-9_]+$
+good-names=bar,df,fn
+
+[MISCELLANEOUS]
+notes=

pylintrc

@@ -31,13 +31,15 @@
         'blessed>=1.17',
         'psutil>=5.6',
         'requests>=2.24',
-        'ruff>=0.1.0',
     ],
     extras_require={
         'nbrun': [
             'ipython>=7.10.0',
             'nbconvert>=5.6.1',
         ],
+        'dev': [
+            'ruff>=0.1.0',
+        ],
     },
     classifiers=[
         'Development Status :: 4 - Beta',