Merge pull request #5 from slayoo/main

satisfying pylint :)

Author: slayoo

.github/workflows/pylint.yml

@@ -1,6 +1,10 @@
 name: Pylint
 
-on: [push]
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
 
 jobs:
   build:
@@ -19,4 +23,5 @@ jobs:
         pip install pylint
     - name: Analysing the code with pylint
       run: |
-        pylint `ls -R|grep .py$|xargs`
+        pylint $(git ls-files '*.py')
+

atmos_cloud_sim_uj_utils/__init__.py

@@ -1 +1,4 @@
-from .pip_install_on_colab import pip_install_on_colab
+"""
+utility routines used in PySDM and PyMPDATA examples and tests
+"""
+from atmos_cloud_sim_uj_utils.pip_install_on_colab import pip_install_on_colab

atmos_cloud_sim_uj_utils/pip_install_on_colab.py

@@ -1,8 +1,15 @@
+# pylint: disable-next=missing-module-docstring
+
 def pip_install_on_colab(*args):
+    """executes pip (and ldconfig) ensuring Colab subtleties are handled as sane as it can get"""
+    # pylint: disable-next=import-outside-toplevel
+    # pylint: disable-next=multiple-imports
+    # pylint: disable-next=import-error
     import subprocess, notebook, tornado, sys
-    subprocess.check_call([sys.executable, '-m', 'pip', '--quiet', '--use-deprecated=legacy-resolver', 'install',
-                           f'notebook=={notebook.__version__}',
-                           f'tornado=={tornado.version}',
-                           *args]
-                          )
+    subprocess.check_call([
+      sys.executable, '-m', 'pip', '--quiet', '--use-deprecated=legacy-resolver', 'install',
+      f'notebook=={notebook.__version__}',
+      f'tornado=={tornado.version}',
+      *args
+    ])
     subprocess.check_call(['ldconfig'])

setup.py

@@ -1,8 +1,11 @@
+"""
+the magick behind ``pip install ...``
+"""
 from setuptools import setup, find_packages
-import os
 
 
 def get_long_description():
+    """returns contents of README.md file"""
     with open("README.md", "r", encoding="utf8") as file:
         long_description = file.read()
     return long_description