How To check code style and typing

carpedm20 · Sep 12, 2024 · 8dc09b7 · 8dc09b7
1 parent fc30895
commit 8dc09b7
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -97,6 +97,23 @@ with `BeautifulSoup <http://www.crummy.com/software/BeautifulSoup/>`__
 and prints the contents to ``stdout`` as a Python dictionary. For more
 information take a look in the `utils/README.md <utils/README.md>`__ file.
 
+Check the code style with:
+
+.. code-block:: console
+
+    $ python -m pip install ruff
+    $ ruff check emoji
+
+Test the type checks with:
+
+.. code-block:: console
+
+    $ python -m pip install pyright mypy typeguard
+    $ pyright emoji
+    $ pyright tests
+    $ mypy emoji
+    $ pytest --typeguard-packages=emoji
+
 
 Links
 -----