Migration from old pyutilz package name (which, in turn, came from
[pyutils.git] / 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.
9
10 Code is under src/*.  Most code includes doctests.
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/ for more options / information.
18
19 This package generates Sphinx docs which are available at:
20
21     https://wannabe.guru.org/pydocs/pyutils/pyutils.html
22
23 For a long time this was just a local library on my machine that
24 my tools imported but I've decided to release it on PyPi.  I hope
25 you find it useful.  LICENSE and NOTICE describe reusing it and
26 where everything came from.  Drop me a line if you are using this,
27 find a bug, or have a question.
28
29   --Scott Gasch ([email protected])
30