pyInspect Files

# pyInspect
Create a simple class diagram with docstring and variable descriptions.

pyInspect Version 0.8
---------------------------
Copyright (C) 2016 Damian Chrzanowski
pjdamian.chrzanowski@gmail.com
License : GNU Public License v3 

Overview:
Creates a html file that contains all (almost) information about your .py code's classes and their methods.
All information is extracted from the docstrings and from comments in case of __init__ method's variables.

Usage:
 
 - Windows:
 Launch the pyinspect0.8.exe file and follow the prompts.
 The package is a bit heavy as it also includes the 2.7 version of python.
 Your anti-viral software might sand box the installation and hang for up to 15 sec.
 The installation will resume after the scan is finished.
 After the installation is completed. Find pyInspect program in your Start Menu. Enjoy!
 
 From source code:
 Make sure that you hava python 2.7 installed.  https://www.python.org/download/releases/2.7/
 If you do not have the EasyGui(c) library. Get it here https://sourceforge.net/projects/easygui/
 Once python 2.7 is installed, just double click the downloaded pyInspect.py file to launch the program.
 - Linux:
 Download the source code.
 Navigate to the folder in which you have your pyInspect.py file.
 Right click and select 'open the terminal window here'.
 Type in python pyInspect.py.

TODO:
- Inheritance.
- Code does not recognize comments for self.variable if they are not placed in the same line.
- The reverse. Make a .py file out of a class diagram.

Change Log:

- version 0.8
    - fixed a bug which cause class variables being not properly recognised if the had an in-line IF statement
	- added an executable version for the windows operating system.
- version 0.7a
    - added the .py file name to the output html file name.
- version 0.7
    - handles non flake8 docstrings.
- version 0.6
    - now creates an animated version of the website.

========================================
License

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 3 of the License, or
(at your option) any later version.

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, see:
http://www.gnu.org/licenses/
========================================

pyInspect uses:

EasyGui version 0.98.0
Copyright (c) -2016, Stephen Raymond Ferg
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


pynsist 1.6

nsist/glossyorb.ico is under a CC Attribution 3.0 License, by "Mysitemyway.com", from
http://www.iconarchive.com/show/clean-3d-icons-by-mysitemyway/glossy-3d-blue-orbs2-112-icon.html

Other files in this repo are under the MIT license below.

The MIT License
---------------

Copyright (c) 2014 Thomas Kluyver

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.