You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: python/README.md
+39-1
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,7 @@ Install the packages for the example by running the following:
74
74
python -m pip install -r requirements.txt
75
75
```
76
76
77
-
This installs all of the packages listed in the `requirements.txt` file in the current
77
+
This installs all the packages listed in the `requirements.txt` file in the current
78
78
folder.
79
79
80
80
### Run the code
@@ -90,6 +90,44 @@ Some examples require command line arguments. In these cases, you can run the ex
90
90
with a `-h` flag to get help. Each example has a README.md that describes additional
91
91
specifics about how to run the example and any other prerequisites.
92
92
93
+
## Linting and formatting
94
+
We rely on [pylint](https://pylint.pycqa.org/en/latest/) and [black](https://black.readthedocs.io/en/stable/) to keep this code consistently formatted and styled.
95
+
To contribute Python code to this project, please refer to the following installation and usage steps.
96
+
97
+
### Using Pylint
98
+
We run Pylint using [a custom configuration file](.github/linters/.python-lint) against any changed file or directory. See the [Python Github Action workflow](../.github/workflows/python.yml) for details.
99
+
100
+
To invoke Pylint yourself, first install it with `pip install pylint`.
0 commit comments