X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=docs%2Fpyutils.rst;h=eb839075ce8b6c69b8fc7b84df8424f2fd19e9d3;hb=e699089d766afa2ac4e665724160a12d28d4ade7;hp=2e96cbb530d40ffcccf50d138588b34a936dca3a;hpb=b6bd182dcf2b61053e91abb529143eaafb0cec22;p=pyutils.git diff --git a/docs/pyutils.rst b/docs/pyutils.rst index 2e96cbb..eb83907 100644 --- a/docs/pyutils.rst +++ b/docs/pyutils.rst @@ -50,7 +50,7 @@ Most code includes inline documentation and doctests. I've tried to organize it into logical packages based on the code's functionality. Note that when words would collide with a Python standard library or reserved keyword I've used a 'z' at the end, e.g. 'collectionz' -instead of 'collections', 'typez' instead of 'type', etc... +instead of 'collections'. There's some example code that uses various features of this project checked in under `examples/ `_ that you can check out. See the `README `__ in that directory for more information @@ -83,6 +83,7 @@ To actually build the code (by which I mean type check it, lint it, package it, it, etc...) you need some other dependencies installed: - black: I use black to auto-format the code + - mypy: a Python type checker - coverage: used by the --coverage option of `run_tests.py`. - flake8: a Python linter - pylint: another Python linter @@ -113,12 +114,12 @@ Subpackages pyutils.collectionz pyutils.compress - pyutils.datetimez + pyutils.datetimes pyutils.files pyutils.parallelize pyutils.search pyutils.security - pyutils.typez + pyutils.types Submodules ----------