README.md

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