README.md

   1 # pyutils
   2
   3 This is a collection of Python utilities that I wrote and find useful.
   4 From collections that try to emulate Pythonic patterns
   5 (pyutils.collectionz) to a "smart" natural language date parser
   6 (pyutils.datetimez.dateparse_utils), to filesystem helpers
   7 (pyutils.files.file_utils) to a "simple" parallelization framework
   8 (pyutils.parallelize.parallelize).  I hope you find them useful, too.
   9
  10 Code is under src/pyutils/*.  Most code includes doctests inline.
  11
  12 Tests are under tests/*.  To run all tests:
  13
  14     cd tests/
  15     ./run_tests.py --all [--coverage]
  16
  17 See the README under tests/ and the code of run_tests.py for more
  18 options / information.
  19
  20 This package generates Sphinx docs which are available at:
  21
  22     https://wannabe.guru.org/pydocs/pyutils/pyutils.html
  23
  24 Package code is checked into a local git server and available to clone
  25 from https://wannabe.guru.org/git/pyutils.git or under:
  26
  27     https://wannabe.guru.org/gitweb/?p=pyutils.git;a=summary
  28
  29 For a long time this was just a local library on my machine that my
  30 tools imported but I've now decided to release it on PyPi.  Early
  31 development happened in a different git repo:
  32
  33     https://wannabe.guru.org/gitweb/?p=python_utils.git;a=summary
  34
  35 I hope you find this useful.  LICENSE and NOTICE describe reusing it
  36 and where everything came from.  Drop me a line if you are using this,
  37 find a bug, or have a question.
  38
  39   --Scott Gasch ([email protected])
  40