Merge branch 'feature-double-sided'; v11.1.0

Author: pjkundert

requirements.txt

@@ -3,7 +3,7 @@ chacha20poly1305	>=0.0.3
 click			>=8.1.3,<9
 crypto-licensing	>=3.3.2,<4
 cx_Freeze		>=6.12		; sys_platform == "win32"
-fpdf2			>=2.5.7,<3
+fpdf2			>=2.7.6,<3
 hdwallet		>=2.2.1,<3
 mnemonic		>=0.2,	<1
 qrcode			>=7.3

slip39/layout/components.py

@@ -281,6 +281,10 @@ def layout_card(
     card_mnemonics		= card_bottom.add_region_proportional(
         Region( 'card-mnemonics', x1=0, y1=0, x2=13/16, y2=1 )
     )
+    # QR code for Card Mnemonics on back is center/middle of Mnemonics area
+    card_mnemonics.add_region(
+        Image( 'card-qr-mnem' )
+    ).square( justify='T' )
 
     # QR codes sqaare, and anchored to top and bottom of card.
     card_bottom.add_region_proportional(
@@ -570,12 +574,16 @@ def layout_components(
     comp_rows			= int(( pdf.eph - page_margin_mm * 2 * min( 1, 1 - bleed )) // comp_dim.y )
     comps_pp			= comp_rows * comp_cols
 
+    # Compute actual page margins to center cards.
+    page_margin_tb		= ( pdf.eph - comp_rows * comp_dim.y ) / 2
+    page_margin_lr		= ( pdf.epw - comp_cols * comp_dim.x ) / 2
+
     def page_xy( num: int ) -> Tuple[int, Coordinate]:
         """Returns the page, and the coordinates within that page of the num'th component"""
         page,nth		= divmod( num, comps_pp )
         page_rows,page_cols	= divmod( nth, comp_cols )
-        offsetx			= page_margin_mm + page_cols * comp_dim.x
-        offsety			= page_margin_mm + page_rows * comp_dim.y
+        offsetx			= page_margin_lr + page_cols * comp_dim.x
+        offsety			= page_margin_tb + page_rows * comp_dim.y
         log.debug( f"{ordinal(num)} {comp_dim.x:7.5f}mm x {comp_dim.y:7.5f}mm component on page {page}, offset {offsetx:7.5f}mm x {offsety:7.5f}mm" )
         return (page, Coordinate( x=offsetx, y=offsety ))
 

slip39/layout/pdf.py

@@ -25,13 +25,15 @@
 import warnings
 
 from datetime		import datetime
-from collections	import namedtuple
+from collections	import namedtuple, defaultdict
 from collections.abc	import Callable
 from pathlib		import Path
 from typing		import Dict, List, Tuple, Optional, Sequence, Any
 
 import qrcode
+import qrcode.image.svg
 import fpdf		# FPDF, FlexTemplate, FPDF_FONT_DIR
+import fpdf.svg
 
 from ..api		import Account, cryptopaths_parser, create, enumerate_mnemonic, group_parser
 from ..util		import chunker
@@ -199,19 +201,24 @@ def produce_pdf(
     orientations: Sequence[str]	= None,		# available orientations; default portrait, landscape
     cover_text: Optional[str]	= None,		# Any Cover Page text; we'll append BIP-39 if 'using_bip39'
     watermark: Optional[str]	= None,
+    double_sided: Optional[bool]= None,
 ) -> Tuple[Tuple[str,str], fpdf.FPDF, Sequence[Sequence[Account]]]:
     """Produces an FPDF containing the specified SLIP-39 Mnemonics group recovery cards.
 
     Returns the required Paper description [<format>,<orientation>], the FPDF containing the
     produced cards, and the cryptocurrency accounts from the supplied slip39.Details.
 
     Makes available several fonts.
+
+    Produces double-sided PDF by default, containing QR codes for SLIP-39 Mnemonics on the back.
     """
     if paper_format is None:
         paper_format		= PAPER
     if orientations is None:
         orientations		= ('portrait', 'landscape')
 
+    double_sided		= True if double_sided is None else bool( double_sided )
+
     # Deduce the card size.  All papers sizes are specified in inches.
     try:
         (card_h,card_w),card_margin = CARD_SIZES[card_format.lower()]
@@ -249,18 +256,19 @@ def produce_pdf(
     # Convert all of the first group's account(s) to an address QR code
     assert accounts and accounts[0], \
         "At least one cryptocurrency account must be supplied"
-    qr				= {}
+    qr_acct			= {}
     for i,acct in enumerate( accounts[0] ):
         qrc			= qrcode.QRCode(
-            version	= None,
-            error_correction = qrcode.constants.ERROR_CORRECT_M,
-            box_size	= 10,
-            border	= 1
+            version		= None,
+            error_correction	= qrcode.constants.ERROR_CORRECT_M,
+            box_size		= 10,
+            border		= 1,
+            image_factory	= qrcode.image.svg.SvgPathImage,
         )
         qrc.add_data( acct.address )
         qrc.make( fit=True )
 
-        qr[i]			= qrc.make_image()
+        qr_acct[i]		= qrc.make_image()
         if log.isEnabledFor( logging.INFO ):
             f			= io.StringIO()
             qrc.print_ascii( out=f )
@@ -333,31 +341,66 @@ def produce_pdf(
         else:
             tpl_cover.render()
 
+        if double_sided:
+            pdf.add_page()
+
+
+    # Compute the contents of the cards; the keys and their values are the attributes of
+    # each template.  Creates pages of cards (<pos>,<front>,<back>).
+    page			= []  # A sequence of pages [[<card>,..],..]
     card_n			= 0
-    page_n			= None
     for g_n,(g_name,(g_of,g_mnems)) in enumerate( groups.items() ):
         for mn_n,mnem in enumerate( g_mnems ):
-            p,(offsetx,offsety)	= page_xy( card_n )
-            if p != page_n:
-                pdf.add_page()
-                page_n		= p
+            p_n,(p_x,p_y)	= page_xy( card_n )
             card_n	       += 1
+            if p_n == len(page):
+                page.append([])
+            page[-1].append( ((p_n,(p_x,p_y)), dict(), dict()) )
+
+            _,f,b		= page[-1][-1]
 
-            tpl['card-title']	= f"SLIP39 {g_name}({mn_n+1}/{len(g_mnems)}) for: {name}"
-            tpl['card-requires'] = requires
-            tpl['card-crypto1']	= f"{accounts[0][0].crypto} {accounts[0][0].path}: {accounts[0][0].address}"
-            tpl['card-qr1']	= qr[0].get_image()
+            f['card-title']	= \
+            b['card-title']	= f"SLIP39 {g_name}({mn_n+1}/{len(g_mnems)}) for: {name}"
+            f['card-requires']	= requires
+            f['card-crypto1']	= f"{accounts[0][0].crypto} {accounts[0][0].path}: {accounts[0][0].address}"
+            f['card-qr1']	= io.BytesIO( qr_acct[0].to_string(encoding='unicode').encode('UTF-8')) # get_image()
             if len( accounts[0] ) > 1:
-                tpl['card-crypto2'] = f"{accounts[0][1].crypto} {accounts[0][1].path}: {accounts[0][1].address}"
-                tpl['card-qr2']	= qr[1].get_image()
-            tpl[f'card-g{g_n}']	= f"{g_name:7.7}..{mn_n+1}" if len(g_name) > 8 else f"{g_name} {mn_n+1}"
-            tpl['card-link']	= 'slip39.com'
+                f['card-crypto2'] = f"{accounts[0][1].crypto} {accounts[0][1].path}: {accounts[0][1].address}"
+                f['card-qr2']	= io.BytesIO( qr_acct[1].to_string(encoding='unicode').encode('UTF-8'))  # get_image()
+            f[f'card-g{g_n}']	= \
+            b[f'card-g{g_n}']	= f"{g_name:7.7}..{mn_n+1}" if len(g_name) > 8 else f"{g_name} {mn_n+1}"
             if watermark:
-                tpl['card-watermark'] = watermark
+                f['card-watermark'] = watermark
             for n,m in enumerate_mnemonic( mnem ).items():
-                tpl[f"mnem-{n}"] = m
+                f[f"mnem-{n}"]	= m
+
+            # Back contains QR code of the card's SLIP-39 Mnemonic
+            qrc			= qrcode.QRCode(
+                version		= None,
+                error_correction = qrcode.constants.ERROR_CORRECT_M,
+                box_size	= 10,
+                border		= 1,
+                image_factory	= qrcode.image.svg.SvgPathImage
+            )
+            qrc.add_data( mnem )
+            qrc.make( fit=True )
+
+            b['card-qr-mnem']	= io.BytesIO( qrc.make_image().to_string(encoding='unicode').encode('UTF-8'))  # get_image()
 
-            tpl.render( offsetx=offsetx, offsety=offsety )
+    # Now render the front and (optionally) back cards for each page
+    for p_n,p in enumerate( page ):
+        pdf.add_page()
+        for c_n,((_,(p_x,p_y)),f,b) in enumerate( p ):
+            for key,txt in f.items():
+                tpl[key] 	= txt
+            tpl.render( offsetx=p_x, offsety=p_y )
+        if not double_sided:
+            continue
+        pdf.add_page()
+        for c_n,((_,(p_x,p_y)),f,b) in enumerate( p ):
+            for key,txt in b.items():
+                tpl[key] 	= txt
+            tpl.render( offsetx=pdf.epw - p_x - card_dim.x, offsety=p_y )
 
     return (paper_format,orientation),pdf,accounts
 
@@ -384,6 +427,7 @@ def write_pdfs(
     wallet_paper	= None,		# default Wallets to output on Letter format paper,
     cover_page		= True,         # Produce a cover page (including BIP-39 Mnemonic, if using_bip39)
     watermark		= None,		# Any watermark desired on each output
+    double_sided	= None,
 ):
     """Writes a PDF containing a unique SLIP-39 encoded Seed Entropy for each of the names specified.
 
@@ -486,6 +530,7 @@ def write_pdfs(
                 orientations	= ('portrait', ) if wallet_pwd else None,
                 cover_text	= cover_text,
                 watermark	= watermark,
+                double_sided	= double_sided,
             )
 
         now			= datetime.now()

slip39/main.py

@@ -115,6 +115,13 @@ def main( argv=None ):
     ap.add_argument( '--watermark',
                      default=None,
                      help="Include a watermark on the output SLIP-39 mnemonic cards" )
+    ap.add_argument( '--double-sided', action='store_true',
+                     default=None,
+                     help="Enable double-sided PDF (default)" )
+    ap.add_argument( '--no-double-sided', dest="double_sided", action='store_false',
+                     help="Disable double-sided PDF" )
+    ap.add_argument( '--single-sided', dest="double_sided", action='store_false',
+                     help="Enable single-sided PDF" )
     ap.add_argument( 'names', nargs="*",
                      help="Account names to produce; if --secret Entropy is supplied, only one is allowed.")
     args			= ap.parse_args( argv )
@@ -216,6 +223,7 @@ def main( argv=None ):
             wallet_format	= wallet_format,
             cover_page		= args.cover_page,
             watermark		= args.watermark,
+            double_sided	= args.double_sided,
         )))
     except Exception as exc:
         log.exception( f"Failed to write PDFs: {exc}" )

slip39/version.py

@@ -1,2 +1,2 @@
-__version_info__		= ( 11, 0, 3 )
+__version_info__		= ( 11, 1, 0 )
 __version__			= '.'.join( map( str, __version_info__ ))