examples/README

   1 Stuff under here is example code that uses pyutils library routines and
   2 is meant to just be illustrative and fun.  Each should be runnable as-is
   3 if you have pyutils installed.  Use the --help flag for more info.
   4
   5 cron:
   6     Wrapper for running cronjobs with optional locks to ensure that no
   7     more than one instance executes at the same time, optional max
   8     frequencies, optionally touch a file on successful execution to
   9     drive monitoring, etc...
  10
  11 dedup_files:
  12     Util that traverses a directory structure and identifies files that
  13     are duplicates of each other then optionally deletes duplicates or
  14     symlinks duplicates back to an original.
  15
  16 fff:
  17     Find f'ed fstrings... not so much an example but rather a
  18     development tool.  Identifies places where I meant to use an
  19     f-string (used braces in a string) but didn't make the string an
  20     f-string.  I run this as a pre-commit hook and thought it would be
  21     good to include.
  22
  23 parallelize_config:
  24     This is a sample config file (place in ~/.remote_worker_records or
  25     override with --remote_worker_records_file) for the @parallelize
  26     framework to understand how to dispatch work to remote machines.
  27
  28 pyskel:
  29     This is a "skeleton" I keep around for when I want to start
  30     working on a new script.
  31
  32 reminder:
  33     Reminds you of important dates which are stored in the .reminder
  34     file.
  35
  36 scrabble:
  37     Helps you play Scrabble word game.
  38
  39 wordle:
  40     Plays and helps you cheat at the Wordle word game.  Demo of using
  41     the @parallelize framework and shared_dict which it uses to
  42     precompute the solution space on several processes at once.
  43
  44 ../tests/run_tests.py:
  45     Though not under examples/ this is still a stand alone program that
  46     uses pyutils concepts like @parallelize and smart_futures that might
  47     be helpful to look at.
  48