X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=docs%2Fpyutils.rst;h=3581bef6ca93e7e57be83d497ef66d313cae3d50;hb=cb25f35595b220b0573170954183d6c296d511e5;hp=0836f3149d834cbc5d583159aa47385a0019bd7f;hpb=6e7ee87b17b87abb3b598d39da6b4eed2c8e7697;p=pyutils.git diff --git a/docs/pyutils.rst b/docs/pyutils.rst index 0836f31..3581bef 100644 --- a/docs/pyutils.rst +++ b/docs/pyutils.rst @@ -41,6 +41,11 @@ stable: - overrides: code decorator to mark and enforce method overrides. - pytz: Python timezones, used in date parser and utils. +You can also install the wheel directly; the latest is checked in under: https://wannabe.guru.org/gitweb/?p=pyutils.git;a=tree;f=dist;hb=HEAD. To do so, download it, check that the MD5 +matches, and run:: + + pip install + Development ----------- @@ -50,7 +55,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 +88,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 +119,12 @@ Subpackages pyutils.collectionz pyutils.compress - pyutils.datetimez + pyutils.datetimes pyutils.files pyutils.parallelize pyutils.search pyutils.security - pyutils.typez + pyutils.types Submodules ---------- @@ -2270,6 +2276,14 @@ during runtime) via Zookeeper (which is disabled by default). :undoc-members: :show-inheritance: +pyutils.dataclass\_utils module +------------------------------- + +.. automodule:: pyutils.dataclass_utils + :members: + :undoc-members: + :show-inheritance: + pyutils.decorator\_utils module ------------------------------- @@ -2302,6 +2316,14 @@ pyutils.function\_utils module :undoc-members: :show-inheritance: +pyutils.graph module +------------------------------ + +.. automodule:: pyutils.graph + :members: + :undoc-members: + :show-inheritance: + pyutils.id\_generator module ----------------------------