# Overview

plib3.classes ============= The PLIB3.CLASSES package contains a number of useful packages and modules that extend the Python 3 standard library. Note: PLIB3.CLASSES works with Python 3. If you are using Python 2.7, see the PLIB.CLASSES package, available at https://bitbucket.org/pdonis/plib-classes. The setup.py script for PLIB3.CLASSES uses the setuputils helper module, which helps to automate away much of the boilerplate in Python 3 setup scripts. This module is available as a separate release at https://github.com/pdonis/setuputils3. The PLIB3.CLASSES Package ------------------------- The following classes are available in the plib.classes namespace: - The StateMachine class implements a basic finite state machine with customizable code to be run at each state transition. Installation ------------ To install PLIB3.CLASSES, you can simply run:: \$ python3 setup.py install at a shell prompt from the directory into which you unzipped the source tarball (the same directory that this README file is in). This will install PLIB3 and then run each of the post-install scripts in the scripts directory. The Zen of PLIB3 ---------------- There is no single unifying purpose or theme to PLIB3, but like Python itself, it does have a 'Zen' of sorts: - Express everything possible in terms of built-in Python data structures. - Once you've expressed it that way, what the code is going to do with it should be obvious. - Avoid boilerplate code, *and* boilerplate data. Every piece of data your program needs should have one and only one source. Copyright and License --------------------- PLIB3.CLASSES is Copyright (C) 2008-2015 by Peter A. Donis. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. (See the LICENSE file for a copy of version 2 of the License.) This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.