black (ssciwr#3)

* black

* revert changes on example1

Author: iulusoy

Diff for: Material_Part3_Formatter/README.md

@@ -0,0 +1,34 @@
+# Code formatter
+A code formatter takes care of formatting your code so that it adheres to the styling standards. For Python, a popular code formatter is [black](https://black.readthedocs.io/en/stable/). Black is PEP 8 compliant but also adds some [own flavor](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html) to the code. Comparing code that has been formatted with black makes it easier to spot the differences. You can even try it out [online](https://black.vercel.app/?version=stable&state=_Td6WFoAAATm1rRGAgAhARYAAAB0L-Wj4ARsAnNdAD2IimZxl1N_WlkPinBFoXIfdFTaTVkGVeHShArYj9yPlDvwBA7LhGo8BvRQqDilPtgsfdKl-ha7EFp0Ma6lY_06IceKiVsJ3BpoICJM9wU1VJLD7l3qd5xTmo78LqThf9uibGWcWCD16LBOn0JK8rhhx_Gf2ClySDJtvm7zQJ1Z-Ipmv9D7I_zhjztfi2UTVsJp7917XToHBm2EoNZqyE8homtGskFIiif5EZthHQvvOj8S2gJx8_t_UpWp1ScpIsD_Xq83LX-B956I_EBIeNoGwZZPFC5zAIoMeiaC1jU-sdOHVucLJM_x-jkzMvK8Utdfvp9MMvKyTfb_BZoe0-FAc2ZVlXEpwYgJVAGdCXv3lQT4bpTXyBwDrDVrUeJDivSSwOvT8tlnuMrXoD1Sk2NZB5SHyNmZsfyAEqLALbUnhkX8hbt5U2yNQRDf1LQhuUIOii6k6H9wnDNRnBiQHUfzKfW1CLiThnuVFjlCxQhJ60u67n3EK38XxHkQdOocJXpBNO51E4-f9z2hj0EDTu_ScuqOiC9cI8qJ4grSZIOnnQLv9WPvmCzx5zib3JacesIxMVvZNQiljq_gL7udm1yeXQjENOrBWbfBEkv1P4izWeAysoJgZUhtZFwKFdoCGt2TXe3xQ-wVZFS5KoMPhGFDZGPKzpK15caQOnWobOHLKaL8eFA-qI44qZrMQ7sSLn04bYeenNR2Vxz7hvK0lJhkgKrpVfUnZrtF-e-ubeeUCThWus4jZbKlFBe2Kroz90Elij_UZBMFCcFo0CfIx5mGlrINrTJLhERszRMMDd39XsBDzpZIYV4TcG7HoMS_IF8aMAAAxI-5uTWXbUQAAY8F7QgAAP01Vc6xxGf7AgAAAAAEWVo=).
+
+You first need to install black using
+```
+pip install black
+```
+You can then use black running it as 
+```
+black Material_Part3_Formatter/example1.py
+```
+Please note that the formatter reformats the file in-place, that means, substituting the content of the original file!
+
+Now you can check with flake8 if the file is compliant with PEP 8:
+```
+flake8 Material_Part3_Formatter/example1.py
+```
+You will notice that flake8 is not returning errors except a line length error for one of the comment lines: Note that black does not reformat comments other than inserting proper whitespace before and after the #.
+
+## Black configuration
+Sometimes you only want to check what black would actually reformat. In order to do so, run
+```
+black Material_Part2_Formatter/example1.py --diff
+```
+or
+```
+black Material_Part2_Formatter/example1.py --diff --color
+```
+
+## Black with jupyter notebooks
+
+```
+pip install 'black[jupyter]'
+```

Diff for: Material_Part3_Formatter/example1.py

@@ -0,0 +1,34 @@
+import os
+import glob
+
+
+
+# find all png files in a folder
+def find_files(path=None, pattern="*.png", recursive=True, limit = 20) -> list:
+    """Find image files on the file system
+
+    :param path:
+        The base directory where we are looking for the images. Defaults to None, which uses the XDG data directory if set or the current working directory otherwise.
+    :param pattern:
+        The naming pattern that the filename should match. Defaults to
+        "*.png". Can be used to allow other patterns or to only include
+        specific prefixes or suffixes.
+    :param recursive:
+        Whether to recurse into subdirectories.
+    :param limit:
+        The maximum number of images to be found. Defaults to 20.
+        To return all images, set to None.
+    """
+    if path is None:
+        path = os.environ.get("XDG_DATA_HOME", ".")
+
+    result=list(glob.glob(f"{path}/{pattern}", recursive=recursive))
+
+    if limit is not None:
+        result = result[:limit]
+
+    return result 
+
+if __name__=="__main__":
+    list = find_files(path="./data/")
+    print("Found files {}".format(list))

Diff for: README.md

@@ -1,3 +1,6 @@
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+
 # Python-best-practices-course
 Material for the course "Python best practices", Scientific Software Center, Heidelberg University
 
@@ -28,8 +31,8 @@ Course date: Nov 8th 2022, 9:00AM - 1:00PM
 
 ## Course content
 
-1. [PEP recommendations](Material_Part1_PEP/PEP_recommendations/README.md)
-1. Linting
+1. [PEP recommendations](Material_Part1_PEP/README.md)
+1. [Linting](Material_Part2_Linter/README.md)
 1. Code formatting
 1. Write better code: Examples
 1. Write better code: Pitfalls