README.md

   1 # pyutils
   2
   3 When I was writing little tools in Python and found myself implementing
   4 a generally useful pattern I stuffed it into a local library.  That
   5 library grew into pyutils: a set of collections, helpers and utilities
   6 that I find useful and hope you will too.
   7
   8 Code is under [src/pyutils/](https://wannabe.guru.org/gitweb/?p=pyutils.git;a=tree;f=src/pyutils;hb=HEAD).
   9 Most code includes inline documentation and doctests.  I've tried to
  10 organize it into logical packages based on the code's functionality.
  11 Note that when words would collide with a Python library or reserved
  12 word I've used a 'z' at the end, e.g. 'collectionz' instead of
  13 'collections', 'typez' instead of 'type', etc...
  14
  15 There's some example code that uses various features of this project checked
  16 in under [examples/](https://wannabe.guru.org/gitweb/?p=pyutils.git;a=tree;f=examples;h=d9744bf2b171ba7a9ff21ae1d3862b673647fff4;hb=HEAD) that you can check out.
  17
  18 Unit and integration tests are under [tests/](
  19 https://wannabe.guru.org/gitweb/?p=pyutils.git;a=tree;f=tests;h=8c303f23cd89b6d2e4fbf214a5c7dcc0941151b4;hb=HEAD).  To run all tests:
  20
  21     cd tests/
  22     ./run_tests.py --all [--coverage]
  23
  24 See the [README](https://wannabe.guru.org/gitweb/?p=pyutils.git;a=blob_plain;f=tests/README;hb=HEAD)) under `tests/` and the code of `run_tests.py` for more options / information about running tests.
  25
  26 This package generates Sphinx docs which are available at [https://wannabe.guru.org/pydocs/pyutils/pyutils.html](https://wannabe.guru.org/pydocs/pyutils/pyutils.html)
  27
  28 Package code is checked into a local git server and available to clone
  29 from git at https://wannabe.guru.org/git/pyutils.git or to view in a
  30 web browser at [https://wannabe.guru.org/gitweb/?p=pyutils.git;a=summary](https://wannabe.guru.org/gitweb/?p=pyutils.git;a=summary)
  31
  32 For a long time this was just a local library on my machine that my
  33 tools imported but I've now decided to release it on PyPi.  Earlier
  34 development happened in a different git repo [https://wannabe.guru.org/gitweb/?p=python_utils.git;a=summary](https://wannabe.guru.org/gitweb/?p=python_utils.git;a=summary)
  35
  36 The [LICENSE](https://wannabe.guru.org/gitweb/?p=pyutils.git;a=blob_plain;f=LICENSE;hb=HEAD)
  37 and [NOTICE](https://wannabe.guru.org/gitweb/?p=pyutils.git;a=blob_plain;f=NOTICE;hb=HEAD)
  38 files at the root of the project describe reusing this code and where
  39 everything came from.  Drop me a line if you are using this, find a
  40 bug, have a question, or have a suggestion:
  41
  42   --Scott Gasch ([email protected])