New example.png. Refactored examples. Rel path.

Refactored all three example scripts. Using __name__ == '__main__' and
other proper code styling.

Updated example.png screenshot with latest output on Win10 (instead of
8), XP (without themes), and OSX.

Using relative path to picture in README so different branches and tags
show their version of the picture. Instead of it always being master.

Having setup.py convert relative path to absolute github path since
picture won't be available on PyPI.

Author: Robpol86

README.rst

@@ -35,7 +35,7 @@ Install:
 Example Implementations
 =======================
 
-.. image:: https://github.com/Robpol86/terminaltables/raw/master/example.png?raw=true
+.. image:: example.png?raw=true
    :alt: Example Scripts Screenshot
 
 Source code for examples: `example1.py <https://github.com/Robpol86/terminaltables/blob/master/example1.py>`_,

example.png

@@ -6,27 +6,37 @@
 
 from __future__ import print_function
 
-from terminaltables import AsciiTable, DoubleTable
-
-
-table_data = [
-    ['Platform', 'Years', 'Notes'],
-    ['Mk5', '2007-2009', 'The Golf Mk5 Variant was\nintroduced in January 2007 and\nproduced up to March 2009.'],
-    ['MKVI', '2009-2013', 'Might actually be Mk5.'],
-]
-table = AsciiTable(table_data, 'Jetta SportWagen')
-print()
-print(table.table)
-
-table = DoubleTable(table_data, 'Jetta SportWagen')
-table.inner_row_border = True
-table.justify_columns[2] = 'right'
-print()
-print(table.table)
-
-table.outer_border = False
-table.justify_columns[1] = 'center'
-print()
-print(table.table)
-
-print()
+from terminaltables import AsciiTable, DoubleTable, SingleTable
+
+TABLE_DATA = (
+    ('Platform', 'Years', 'Notes'),
+    ('Mk5', '2007-2009', 'The Golf Mk5 Variant was\nintroduced in 2007.'),
+    ('MKVI', '2009-2013', 'Might actually be Mk5.'),
+)
+
+
+def main():
+    """Main function."""
+    title = 'Jetta SportWagen'
+
+    # AsciiTable.
+    table_instance = AsciiTable(TABLE_DATA, title)
+    table_instance.justify_columns[2] = 'right'
+    print(table_instance.table)
+    print()
+
+    # SingleTable.
+    table_instance = SingleTable(TABLE_DATA, title)
+    table_instance.justify_columns[2] = 'right'
+    print(table_instance.table)
+    print()
+
+    # DoubleTable.
+    table_instance = DoubleTable(TABLE_DATA, title)
+    table_instance.justify_columns[2] = 'right'
+    print(table_instance.table)
+    print()
+
+
+if __name__ == '__main__':
+    main()

example1.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-"""Example usage of terminaltables using colorclass.
+"""Example usage of terminaltables with colorclass.
 
 Just prints sample text and exits.
 """
@@ -11,43 +11,76 @@
 from terminaltables import SingleTable
 
 
-Windows.enable(auto_colors=True, reset_atexit=True)  # Does nothing if not on Windows.
-
-table_data = [
-    [Color('{autogreen}<10ms{/autogreen}'), '192.168.0.100, 192.168.0.101'],
-    [Color('{autoyellow}10ms <= 100ms{/autoyellow}'), '192.168.0.102, 192.168.0.103'],
-    [Color('{autored}>100ms{/autored}'), '192.168.0.105'],
-]
-table = SingleTable(table_data)
-table.inner_heading_row_border = False
-print()
-print(table.table)
-
-table.title = '192.168.0.105'
-table.justify_columns = {0: 'center', 1: 'center', 2: 'center'}
-table.inner_row_border = True
-table.table_data = [
-    [Color('Low Space'), Color('{autocyan}Nominal Space{/autocyan}'), Color('Excessive Space')],
-    [Color('Low Load'), Color('Nominal Load'), Color('{autored}High Load{/autored}')],
-    [Color('{autocyan}Low Free RAM{/autocyan}'), Color('Nominal Free RAM'), Color('High Free RAM')],
-]
-print()
-print(table.table)
-
-table.title = None
-table.outer_border = False
-table.table_data = [['A', 'B'], ['C', 'D']]
-print()
-print(table.table)
-
-table.outer_border = True
-table.inner_row_border = False
-table.inner_column_border = False
-print()
-print(table.table)
-
-table = SingleTable([['Obey Obey Obey Obey']], 'Instructions')
-print()
-print(table.table)
-
-print()
+def table_server_timings():
+    """Return table string to be printed."""
+    table_data = [
+        [Color('{autogreen}<10ms{/autogreen}'), '192.168.0.100, 192.168.0.101'],
+        [Color('{autoyellow}10ms <= 100ms{/autoyellow}'), '192.168.0.102, 192.168.0.103'],
+        [Color('{autored}>100ms{/autored}'), '192.168.0.105'],
+    ]
+    table_instance = SingleTable(table_data)
+    table_instance.inner_heading_row_border = False
+    return table_instance.table
+
+
+def table_server_status():
+    """Return table string to be printed."""
+    table_data = [
+        [Color('Low Space'), Color('{autocyan}Nominal Space{/autocyan}'), Color('Excessive Space')],
+        [Color('Low Load'), Color('Nominal Load'), Color('{autored}High Load{/autored}')],
+        [Color('{autocyan}Low Free RAM{/autocyan}'), Color('Nominal Free RAM'), Color('High Free RAM')],
+    ]
+    table_instance = SingleTable(table_data, '192.168.0.105')
+    table_instance.inner_heading_row_border = False
+    table_instance.inner_row_border = True
+    table_instance.justify_columns = {0: 'center', 1: 'center', 2: 'center'}
+    return table_instance.table
+
+
+def table_abcd():
+    """Return table string to be printed. Two tables on one line."""
+    table_instance = SingleTable([['A', 'B'], ['C', 'D']])
+
+    # Get first table lines.
+    table_instance.outer_border = False
+    table_inner_borders = table_instance.table.splitlines()
+
+    # Get second table lines.
+    table_instance.outer_border = True
+    table_instance.inner_heading_row_border = False
+    table_instance.inner_column_border = False
+    table_outer_borders = table_instance.table.splitlines()
+
+    # Combine.
+    smallest, largest = sorted([table_inner_borders, table_outer_borders], key=len)
+    smallest += [''] * (len(largest) - len(smallest))  # Make both same size.
+    combined = list()
+    for i, row in enumerate(largest):
+        combined.append(row.ljust(10) + '          ' + smallest[i])
+    return '\n'.join(combined)
+
+
+def main():
+    """Main function."""
+    Windows.enable(auto_colors=True, reset_atexit=True)  # Does nothing if not on Windows.
+
+    # Server timings.
+    print(table_server_timings())
+    print()
+
+    # Server status.
+    print(table_server_status())
+    print()
+
+    # Two A B C D tables.
+    print(table_abcd())
+    print()
+
+    # Instructions.
+    table_instance = SingleTable([['Obey Obey Obey Obey']], 'Instructions')
+    print(table_instance.table)
+    print()
+
+
+if __name__ == '__main__':
+    main()

example2.py

@@ -10,18 +10,27 @@
 
 from terminaltables import SingleTable
 
-
-# Setup string and table.
-long_string = ('Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore '
+LONG_STRING = ('Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore '
                'et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut '
                'aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum '
                'dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui '
                'officia deserunt mollit anim id est laborum.')
-table = SingleTable([['Long String', '']])
 
-# Calculate newlines.
-max_width = table.column_max_width(1)
-wrapped_string = '\n'.join(wrap(long_string, max_width))
-table.table_data[0][1] = wrapped_string
 
-print(table.table)
+def main():
+    """Main function."""
+    table_data = [
+        ['Long String', ''],  # One row. Two columns. Long string will replace this empty string.
+    ]
+    table = SingleTable(table_data)
+
+    # Calculate newlines.
+    max_width = table.column_max_width(1)
+    wrapped_string = '\n'.join(wrap(LONG_STRING, max_width))
+    table.table_data[0][1] = wrapped_string
+
+    print(table.table)
+
+
+if __name__ == '__main__':
+    main()

example3.py

@@ -8,6 +8,9 @@
 
 from setuptools import setup
 
+NAME = 'terminaltables'
+VERSION = '3.0.0'
+
 
 def readme():
     """Try to read README.rst or return empty string if failed.
@@ -17,9 +20,10 @@ def readme():
     """
     path = os.path.realpath(os.path.join(os.path.dirname(__file__), 'README.rst'))
     handle = None
+    url_prefix = 'https://raw.githubusercontent.com/Robpol86/{name}/v{version}/'.format(name=NAME, version=VERSION)
     try:
         handle = codecs.open(path, encoding='utf-8')
-        return handle.read(131072)
+        return handle.read(131072).replace('.. image:: example', '.. image:: {0}example'.format(url_prefix))
     except IOError:
         return ''
     finally:
@@ -55,9 +59,9 @@ def readme():
     keywords='Shell Bash ANSI ASCII terminal tables',
     license='MIT',
     long_description=readme(),
-    name='terminaltables',
-    packages=['terminaltables'],
-    url='https://github.com/Robpol86/terminaltables',
-    version='3.0.0',
+    name=NAME,
+    packages=[NAME],
+    url='https://github.com/Robpol86/' + NAME,
+    version=VERSION,
     zip_safe=True,
 )

setup.py

@@ -51,7 +51,7 @@ commands =
     python -c "assert '{[general]version}' == __import__('{[general]name}').__version__"
     python -c "assert 'author=\'{[general]author}\'' in open('setup.py').read(102400)"
     python -c "assert 'license=\'{[general]license}\'' in open('setup.py').read(102400)"
-    python -c "assert 'version=\'{[general]version}\'' in open('setup.py').read(102400)"
+    python -c "assert 'VERSION = \'{[general]version}\'' in open('setup.py').read(102400)"
     python -c "assert '\n{[general]version} - ' in open('README.rst').read(102400)"
 deps =
     coverage==4.0.3