v0.3.0: Fix empty-card bug, multi-copy cards, pip packagable

Author: mDuo13

README.md

@@ -4,23 +4,29 @@ Proxy Printer
 Generates reasonably good-looking HTML proxies for a card game from an ODS spreadsheet. Useful for making card game prototypes. Comes with some basic CSS; you can add your own style rules to make the proxies prettier or better suited to your game. Does some heuristic text resizing so that text of different lengths is more likely to fit without being too small.
 
 
-Setup
+Installing with pip
 ------
 
-* Python 3 required
-* Install [pyexcel-ods3](https://github.com/pyexcel/pyexcel-ods3)
+(Python 3 required)
+
+```
+pip3 install proxyprinter
+```
+
+(You might need to use `sudo` or a VirtualEnv depending on your system setup.)
+
 
 Usage
 ------
 
-     ./proxyprinter.py cards.ods > output_file.html
+     proxyprinter example-cards.ods > output_file.html
 
-Do `./proxyprinter.py --help` for usage statement with all commandline options.
+Do `proxyprinter --help` for usage statement with all commandline options.
 
 
 Input Format
 -------------
-OpenDocument Spreadsheet (ODF) file. Example: [cards.ods](cards.ods). Each "Sheet" in the document is one type of card in your game. The name of the sheet is the card type. The first row in the sheet lists the titles for each field. Each subsequent row is a card.
+OpenDocument Spreadsheet (ODF) file. Example: [example-cards.ods](example-cards.ods). Each "Sheet" in the document is one type of card in your game. The name of the sheet is the card type. The first row in the sheet lists the titles for each field. Each subsequent row is a card.
 
 The following field names are special in some way:
 
@@ -29,6 +35,7 @@ The following field names are special in some way:
 - **Text**: Gets put in a single text_area alongside Flavor Text.
 - **Flavor Text**: Gets put in a single text_area alongside Text.
 - **Version**: Listed in the footer. Use this with the `-v` switch to only print recently-updated cards.
+- **Copies:** If present and a non-negative integer, prints that many copies of the card as part of the overall print sheet. (Otherwise, the print sheet contains 1 copy of this card.)
 
 
 In-Stylesheet Settings

cards.ods

@@ -6,21 +6,24 @@
 import argparse
 import pyexcel_ods3 as pyexcel
 import hashlib
+import logging
 from cgi import escape
 from random import randint
-from logging import warning
 from collections import OrderedDict
 from time import strftime
+from pkg_resources import resource_string
 
 SPECIAL_FIELDS = [
     "Name", #Title of the card
     "Traits", #Comma-separated list of tags/classes
     "Text", #Shares a box with flavor text
     "Flavor Text", #Italicized, follows text
     "Version", #Appears in footer; can be used to print only updated cards
+    "Copies", #Print the same card this many times
 ]
 
-DEFAULT_STYLE_FILE = "proxyprinter.css"
+DEFAULT_STYLE = resource_string(__name__, "proxyprinter.css").decode('utf-8')
+
 DEFAULT_TEXT_SIZING_THRESHOLDS = {
     "*": (30, 50),
     "Text": (140, 220),
@@ -41,6 +44,11 @@
 SETTING_LABEL_PROCESSPATTERNS = "ProcessPatterns"
 SETTING_LABEL_PROCESSREPLACEMENTS = "ProcessReplacements"
 
+
+#Set up logging
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.StreamHandler())
+
 def escape_html(s):
     #like cgi.escape, but undo escaping  
     return escape(s).replace(" ", " ")
@@ -52,16 +60,18 @@ def replace_all(s, replacements):
 
 def twod_array_to_ordered_dict_array(array2d):
     if len(array2d) < 2 or type(array2d[0]) != list:
-        warning("Not a 2d array?")
+        logger.warning("Not a 2d array?")
         return []
 
     keys = array2d[0]
     vals = array2d[1:]
     od_rows = []
     for row in vals:
+        if not row: #skip empty rows
+            continue
         od = OrderedDict()
         if len(keys) != len(row):
-            warning("Mismatched number of fields in row: %s" % row)
+            logger.info("Mismatched number of fields in row: %s" % row)
 
         for i in range(0, len(keys)):
             if i >= len(row):
@@ -255,17 +265,17 @@ def parse_settings(self):
         self.skip_sheets = [SETTING_SHEET_LABEL]
         self.size_thresholds = DEFAULT_TEXT_SIZING_THRESHOLDS
         if type(self.sheet) != OrderedDict:
-            warning("Single page sheet (%s); no settings pulled"%type(self.sheet))
+            logger.info("Single page sheet (%s); no settings pulled"%type(self.sheet))
             # Single page sheet; no custom settings defined
             return
         elif SETTING_SHEET_LABEL not in self.sheet.keys():
-            warning("No settings sheet found")
+            logger.info("No settings sheet found")
             # No settings sheet; no custom settings defined
             return
 
         settings_sheet = self.sheet[SETTING_SHEET_LABEL]
         if len(settings_sheet) < 2:
-            warning("Less than 2 rows in settings sheet")
+            logger.info("Less than 2 rows in settings sheet")
             return
 
         setting_keys = settings_sheet[0]
@@ -277,7 +287,7 @@ def parse_settings(self):
                 self.addcss = setting_simple_values[
                             setting_keys.index(SETTING_LABEL_CSSFILE)]
             except ValueError:
-                warning("Failed to get addcss value from settings")
+                logger.info("Failed to get addcss value from settings")
         else:
             print("ADDCSS",self.addcss, type(self.addcss))
 
@@ -287,7 +297,7 @@ def parse_settings(self):
                 self.copyowner = setting_simple_values[
                             setting_keys.index(SETTING_LABEL_COPYRIGHT)]
             except ValueError:
-                warning("Failed to get copyright value from settings")
+                logger.info("Failed to get copyright value from settings")
 
         # Setting: Text Size Thresholds
         try:
@@ -296,7 +306,7 @@ def parse_settings(self):
             pos_textsizesmall = setting_keys.index(SETTING_LABEL_TEXTSIZETHRESHOLD2)
             got_textsize_settings = True
         except ValueError:
-            warning("Failed to get text size thresholds from settings")
+            logger.info("Failed to get text size thresholds from settings")
             got_textsize_settings = False
 
         if got_textsize_settings:
@@ -309,7 +319,7 @@ def parse_settings(self):
                     else:
                         threshold_med, threshold_sm = self.size_thresholds["*"]
                 else:
-                    warning("Text Thresholds: Skipping row %s"%row)
+                    logger.debug("Text Thresholds: Skipping row %s"%row)
                     continue
 
                 if len(row) > pos_textsizemed and row[pos_textsizemed]:
@@ -325,7 +335,7 @@ def parse_settings(self):
             pos_richfields = setting_keys.index(SETTING_LABEL_RICHFIELDS)
             got_richfield_settings = True
         except ValueError:
-            warning("Failed to get rich text settings")
+            logger.info("Failed to get rich text settings")
             got_richfield_settings = False
 
         if got_richfield_settings:
@@ -343,7 +353,7 @@ def parse_settings(self):
             pos_processreplacements = setting_keys.index(SETTING_LABEL_PROCESSREPLACEMENTS)
             got_textprocessing_settings = True
         except ValueError:
-            warning("Failed to get text processing settings")
+            logger.info("Failed to get text processing settings")
             got_textprocessing_settings = False
 
         if got_textprocessing_settings:
@@ -404,43 +414,29 @@ def int_from_string_hash(s, min_i, max_i, encoding="utf-8"):
     def render_all(self):
         s = "<!DOCTYPE html>\n<html>\n<head>\n"
         if self.defaultcss:
-            with open(DEFAULT_STYLE_FILE,"r") as f:
-                s += "<style type='text/css'>%s</style>" % f.read()
-            #randomly colorize traits
+            s += "<style type='text/css'>%s</style>" % DEFAULT_STYLE
+        #randomly colorize traits
         if self.colorize:
             s += "<style type='text/css'>%s</style>" % self.trait_colors_css()
         if self.addcss:
             s += "<link rel='stylesheet' href='%s' />" % self.addcss
         s += "</head><body>"
 
         for c in self.cards:
-            s += c.html()
+            s_copies = c.fields.get("Copies", 1)
+            try:
+                copies = int(s_copies)
+            except ValueError:
+                copies = 1
+            if copies < 0:
+                copies = 1
+            s += c.html()*copies
 
         s += "</body></html>"
         return s
 
-# def all_cards(spreadsheet, copyowner, version=None, addcss=None, defaultcss=True):
-#     allcards = []
-#     spreadsheet_data = pyexcel.get_data(spreadsheet)
-#     # A single-sheet file comes back as a 2d array;
-#     # a multi-sheet file comes back as an OrderedDict of sheet names to 2d arrays
-#     if type(spreadsheet_data) == OrderedDict:
-#         pages = spreadsheet_data.items()
-#     else:
-#         pages = {"-": spreadsheet_data}.items()
-#     for sheetname, sheetdata in pages:
-#         cardtype = sheetname
-#         cardrows = twod_array_to_ordered_dict_array(sheetdata)
-#         for row in cardrows:
-#             if cli_args.version:
-#                 if "Version" not in row or str(row["Version"]) != version:
-#                     continue
-#             c = Card(cardtype=sheetname, fields=row, copyowner=copyowner)
-#             allcards.append(c)
 
-
-
-if __name__ == "__main__":
+def main():
     parser = argparse.ArgumentParser(
         description="Generate card images in HTML from spreadsheet.")
     parser.add_argument("spreadsheet", type=str,
@@ -464,3 +460,6 @@ def render_all(self):
             version=cli_args.version, defaultcss=defaultcss, addcss=cli_args.css,
             colorize=colorize)
     print( pp.render_all() )
+
+if __name__ == "__main__":
+    main()

example-cards.ods

@@ -0,0 +1,47 @@
+"""setuptools based setup module"""
+
+from setuptools import setup
+
+# Convert the markdown readme to ReST using Pandoc
+try:
+    import pypandoc
+    long_description = pypandoc.convert('README.md', 'rst')
+except ImportError:
+    long_description = open('README.md').read()
+
+setup(
+    name='proxyprinter',
+    version='0.3.0',
+    description='Generate card game mockups from .ods spreadsheets',
+    long_description=long_description,
+    url='https://github.com/mduo13/proxyprinter',
+    author='Rome Reginelli',
+    author_email='mduo13@gmail.com',
+    license='MIT',
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: Console',
+        'Intended Audience :: End Users/Desktop',
+        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+        'Operating System :: POSIX',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Topic :: Utilities',
+        'Topic :: Games/Entertainment :: Board Games',
+    ],
+    keywords='games mockups proxying design',
+    packages=[
+        'proxyprinter',
+    ],
+    entry_points={
+        'console_scripts': [
+            'proxyprinter = proxyprinter.proxyprinter:main',
+        ],
+    },
+    install_requires=[
+        'pyexcel-ods3',
+    ],
+    package_data={
+        '': ["proxyprinter.css"],
+    }
+)