pywargame 0.4.1__py3-none-any.whl → 0.4.2__py3-none-any.whl

pywargame/__init__.py

@@ -1,2 +1,8 @@
 '''Top-level of module'''
-version = '0.3.0'
+version = '0.4.2'
+
+import pywargame.common     
+import pywargame.vassal     
+import pywargame.cyberboard 
+import pywargame.zuntzu     
+import pywargame.latex      

pywargame/common/__init__.py

@@ -1,3 +1,6 @@
+'''Common utilites
+
+'''
 from . singleton import Singleton
 from . verbose import Verbose
 from . verboseguard import VerboseGuard

pywargame/common/drawdice.py

@@ -1,10 +1,11 @@
 #!/usr/bin/env python
 
-if __name__ == '__main__':
+# --------------------------------------------------------------------
+def diceMain():
     from sys import path
     
     from argparse import ArgumentParser
-    from dicedraw import DiceDrawer
+    from pywargame.common.dicedraw import DiceDrawer
 
     ap = ArgumentParser(description='Make a series of dice images')
     ap.add_argument('-n','--sides', choices=[4,6,8,10,12,20],
@@ -35,6 +36,14 @@ if __name__ == '__main__':
                 range(1,args.sides+1))
     for val in vals:
         dd.draw(val).save(filename=base.format(sides=args.sides,value=val))
+    
+# --------------------------------------------------------------------
+if __name__ == '__main__':
+    diceMain()
+
+# --------------------------------------------------------------------
+#
+# EOF
+#
 
-        
     

pywargame/common/test.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 
-from verboseguard import VerboseGuard
-from verbose import Verbose
+from . verboseguard import VerboseGuard
+from . verbose import Verbose
 
 def inner():
     with VerboseGuard('Entering inner') as g:

pywargame/cyberboard/gbxext.py

@@ -5,17 +5,16 @@
 #    https://github.com/CyberBoardPBEM/cbwindows
 #
 #
-
+## BEGIN_IMPORT
+from pywargame.cyberboard.gamebox   import GameBox
+from pywargame.cyberboard.extractor import GBXExtractor
+from pywargame.common               import Verbose
+## END_IMPORT
 
 # ====================================================================
-if __name__ == '__main__':
+def extractMain():
     from argparse import ArgumentParser, FileType
     from pathlib import Path
-## BEGIN_IMPORT
-    from gamebox   import GameBox
-    from extractor import GBXExtractor
-    from common    import Verbose
-## END_IMPORT
 
     ap = ArgumentParser(description='Extract information from a '
                         'CyberBoard GameBox file and store in ZIP archive',
@@ -58,7 +57,12 @@ if __name__ == '__main__':
         print(rat)
     if 'gbx' in args.dump:
         print(gbx)
-
     
 
-    
+# ====================================================================
+if __name__ == '__main__':
+    extractMain()
+
+#
+# EOF
+#

pywargame/cyberboard/gsnexp.py

@@ -1,16 +1,14 @@
 #!/usr/bin/env python
+## BEGIN_IMPORTS
+from pywargame.common     import Verbose
+from pywargame.cyberboard.exporter    import GSNExporter
+from pywargame.cyberboard.scenario    import Scenario
+from pywargame.cyberboard.extractor   import GSNExtractor
+from pywargame.cyberboard.head        import GBXHeader
+## END_IMPORTS
 
 # ====================================================================
-def gsnexp():
-    ## BEGIN_IMPORTS
-    from sys import path
-    path.append('..')
-    from pywargame.common     import Verbose
-    from pywargame.cyberboard.exporter    import GSNExporter
-    from pywargame.cyberboard.scenario    import Scenario
-    from pywargame.cyberboard.extractor   import GSNExtractor
-    from pywargame.cyberboard.head        import GBXHeader
-    ## END_IMPORTS
+def exportMain():
     
     from argparse import ArgumentParser, FileType, \
          RawDescriptionHelpFormatter 
@@ -147,5 +145,12 @@ def gsnexp():
         raise e
 
 
+# ====================================================================
 if __name__ == '__main__':
     gsnexp()
+
+# ====================================================================
+#
+# EOF
+#
+

pywargame/cyberboard/gsnext.py

@@ -5,17 +5,18 @@
 #    https://github.com/CyberBoardPBEM/cbwindows
 #
 #
-
+# ====================================================================
+## BEGIN_IMPORT
+from pywargame.cyberboard.scenario  import Scenario
+from pywargame.cyberboard.extractor import GSNExtractor
+from pywargame.common               import Verbose
+## END_IMPORT
+    
 
 # ====================================================================
-def gsnext():
+def extractMain():
     from argparse import ArgumentParser, FileType
     from pathlib import Path
-## BEGIN_IMPORT
-    from pywargame.cyberboard.scenario  import Scenario
-    from pywargame.cyberboard.extractor import GSNExtractor
-    from pywargame.common               import Verbose
-## END_IMPORT
 
     ap = ArgumentParser(description='Extract information from a '
                         'CyberBoard Scenario file and store in ZIP archive',
@@ -50,6 +51,7 @@ def gsnext():
     if 'gsn' in args.dump:
         print(gsn)
 
+# ====================================================================
 if __name__ == '__main__':
     gsnext()
     

pywargame/cyberboard/testgrid.py

@@ -146,7 +146,8 @@ def testall():
 
 
 
-testall()
+if __name__ == '__main__':
+    testall()
     
     
                 

pywargame/cyberboard/zeropwd.py

@@ -1,12 +1,14 @@
 #!/usr/bin/env python
 ## BEGIN_IMPORT
-from gamebox import GBXInfo
-from head    import GBXHeader
-from archive import Archive
+from pywargame.cyberboard.gamebox import GBXInfo
+from pywargame.cyberboard.head    import GBXHeader
+from pywargame.cyberboard.archive import Archive
 ## END_IMPORT
 
+# --------------------------------------------------------------------
 nullpwd = b'\xee\n\xcbg\xbc\xdb\x92\x1a\x0c\xd2\xf1y\x83*\x96\xc9'
 
+# --------------------------------------------------------------------
 def zeropwd(filename):
     from pathlib import Path
     
@@ -14,9 +16,7 @@ def zeropwd(filename):
     with Archive(filename,'rb') as ar:
         header       = GBXHeader(ar,GBXHeader.BOX)
         box          = GBXInfo(ar)
-
-
-        pos = ar.tell() - 4*2 - 2 - 2 - 16
+        pos          = ar.tell() - 4*2 - 2 - 2 - 16
 
     with open(filename,'rb') as file:
         cnt = file.read()
@@ -31,15 +31,22 @@ def zeropwd(filename):
     with open(on,'wb') as file:
         file.write(ncnt)
 
-
-if __name__ == '__main__':
+# --------------------------------------------------------------------
+def zeroPwdMain():        
     from argparse import ArgumentParser, FileType
     ap = ArgumentParser(description='Disable password in gamebox')
-    ap.add_argument('input', type=str, help='The file')
+    ap.add_argument('input', type=str, help='The game box file')
 
     args = ap.parse_args()
 
     zeropwd(args.input)
+
+# --------------------------------------------------------------------
+if __name__ == '__main__':
+    zeroPwdMain()
     
-    
-    
+# --------------------------------------------------------------------
+#
+# EOF
+#
+

pywargame/latex/latexexporter.py

@@ -1,11 +1,11 @@
 ## BEGIN_IMPORTS
-from common import VerboseGuard, Verbose
-from vassal.buildfile import BuildFile
-from vassal.documentation import Documentation
-from vassal.traits import *
-from vassal.base import *
-from vassal.moduledata import ModuleData
-from vassal.exporter import Exporter
+from .. common import VerboseGuard, Verbose
+from .. vassal.buildfile import BuildFile
+from .. vassal.documentation import Documentation
+from .. vassal.traits import *
+from .. vassal.base import *
+from .. vassal.moduledata import ModuleData
+from .. vassal.exporter import Exporter
 from pprint import pprint
 
 ## END_IMPORTS

pywargame/latex/main.py

@@ -1,8 +1,8 @@
 #!/usr/bin/env python
 ## BEGIN_IMPORTS
-from latexexporter import LaTeXExporter
-from vassal.vmod import VMod
-from common import Verbose
+from pywargame.latex.latexexporter import LaTeXExporter
+from pywargame.vassal.vmod import VMod
+from pywargame.common import Verbose
 ## END_IMPORTS
 
 from argparse import ArgumentParser
@@ -88,9 +88,9 @@ def exportIt(args):
         
         raise e
     
-    
+
 # ====================================================================
-if __name__ == '__main__':
+def exportMain():
     from argparse import ArgumentParser, FileType
 
     ap = DefaultSubcommandArgParse(description='Create draft VASSAL module')
@@ -178,7 +178,11 @@ if __name__ == '__main__':
         patchIt(args)
     else:
         exportIt(args)
-        
+    
+# ====================================================================
+if __name__ == '__main__':
+    exportMain()
+    
 #
 # EOF
 #

pywargame/vassal/__init__.py

@@ -64,3 +64,4 @@ from . save import *
 from . vsav import *
 from . vmod import *
 from . exporter import *
+from . merger import Merger

pywargame/vassal/buildfile.py

@@ -3,7 +3,7 @@ from .. common import VerboseGuard
 from . base import *
 from . element import Element
 from . game import Game
-from . xml import xmlns
+from . xmlns import xmlns
 ## END_IMPORT
 
 # --------------------------------------------------------------------

pywargame/vassal/collect.py

@@ -28,7 +28,7 @@ if __name__ == '__main__':
           '../common/verbose.py',
           '../common/verboseguard.py',
           '../common/dicedraw.py',
-          'xml.py',
+          'xmlns.py',
           'base.py',
           'element.py',
           'folder.py',
@@ -93,6 +93,7 @@ if __name__ == '__main__':
           'vsav.py',
           'vmod.py',
           'upgrade.py',
-          'exporter.py')
+          'exporter.py',
+          'merger.py')
 
     

pywargame/vassal/collectpatch.py

@@ -2,8 +2,8 @@
 import sys
 sys.path.append('..')
 
-from .. common import Verbose, VerboseGuard
-from .. common.collector import Collector
+from common import Verbose, VerboseGuard
+from common.collector import Collector
 
         
 if __name__ == '__main__':

pywargame/vassal/dumpvsav.py

@@ -1,9 +1,10 @@
 #!/usr/bin/env python
 ## BEGIN_IMPORT
-from .  import SaveIO
+from pywargame.vassal import SaveIO
 ## END_IMPORT
 
-if __name__ == '__main__':
+# ====================================================================
+def dumpMain():
     from argparse import ArgumentParser 
 
     ap = ArgumentParser(description='Dump VASSAL save or log')
@@ -19,6 +20,10 @@ if __name__ == '__main__':
         savemeta, modulemeta = ret[2], ret[3]
 
     print('\n'.join(lines))
+
+# ====================================================================
+if __name__ == '__main__':
+    dumpMain()
 #
 #
 #

pywargame/vassal/element.py

@@ -1,7 +1,7 @@
 ## BEGIN_IMPORT
 from .. common import VerboseGuard
 from . base import *
-from . xml import xmlns
+from . xmlns import xmlns
 ## END_IMPORT
 
 # ====================================================================

pywargame/vassal/gameelements.py

@@ -1059,17 +1059,34 @@ class MultiActionButton(GameElement):
                  disabledIcon = '',    # image when disabled
                  menuItems    = []):   # Button texts
         '''
-        <VASSAL.build.module.MultiActionButton
-          canDisable="false"
-          description="Menu"
-          disabledIcon="" hideWhenDisabled="false"
-          hotkey="67,130"
-          icon="C.png"
-          menuItems="Attacked,Defended" 
-          propertyGate=""
-          text=""
-          tooltip="Clear combat status flags."
-        />
+        A button that executes other buttons (by `buttonText` name)
+
+        Parameters
+        ----------
+        game : pywargame.vassal.Game
+            The game parent
+        node : xml.dom.minidom.Node
+            Possible node
+        description : str
+            Description (comment)
+        text : str
+            Text on button
+        tooltip : str
+            Button tool-tip
+        icon : str
+            Icon on button
+        hotkey : str
+            Hotkey or named command to execute button
+        canDisable : bool
+            If this can be disabled
+        propertyGate : str
+            When property (not expression) is `true`, then disable
+            this button
+        disabledIcon : str
+            Icon to use when disabled
+        menuItems : list of str
+            `buttonText` of other buttons to execute
+            (note, not named commands or hotkeys). 
         '''
         super().__init__(game,
                          self.TAG,

pywargame/vassal/merge.py

@@ -1,12 +1,11 @@
 #!/usr/bin/env python
 ## BEGIN_IMPORTS
-from .  import Merger
-from .. common import Verbose
+from pywargame.vassal import Merger
+from pywargame.common import Verbose
 ## END_IMPORTS
 
-        
 # ====================================================================        
-if __name__ == '__main__':
+def mergeMain():
     from argparse import ArgumentParser, FileType
 
     ap = ArgumentParser(description='Merge two modules or extensions')
@@ -49,7 +48,11 @@ if __name__ == '__main__':
         op.unlink(missing_ok=True)
         
         raise
-
+    
+        
+# ====================================================================        
+if __name__ == '__main__':
+    mergeMain()
     
 
 #

pywargame/vassal/moduledata.py

@@ -2,7 +2,7 @@
 from .. common import VerboseGuard
 from . base import *
 from . element import Element
-from . xml import xmlns
+from . xmlns import xmlns
 ## END_IMPORT
 
 # --------------------------------------------------------------------

pywargame/vassal/patch.py

@@ -2,8 +2,8 @@
 #
 # Patch a module
 ## BEGIN_IMPORTS
-from . vmod import VMod
-from .. common import Verbose
+from pywargame.vassal import VMod
+from pywargame.common import Verbose
 ## END_IMPORT
 
 # ====================================================================
@@ -18,7 +18,7 @@ def patchIt(args):
     VMod.patch(vmodname, patchname, args.verbose)
 
 # ====================================================================
-if __name__ == '__main__':
+def patchMain():
     from argparse import ArgumentParser, FileType
 
     ap = ArgumentParser(description='Patch a module with a Python script')
@@ -35,10 +35,13 @@ if __name__ == '__main__':
                     action='store_true')
 
     args = ap.parse_args()
-
     
     patchIt(args)
-
+    
+# ====================================================================
+if __name__ == '__main__':
+    patchMain()
+    
 #
 # EOF
 #

pywargame/vassal/trait.py

@@ -6,7 +6,8 @@ class Trait:
         
         Unlike the Element classes, this actually holds state that
         isn't reflected elsewhere in the DOM.  This means that the
-        data here is local to the object.  So when we do
+        data here is local to the object.  So when we do::
+
         
             piece  = foo.getPieceSlots()[0]
             traits = p.getTraits()
@@ -14,23 +15,25 @@ class Trait:
                 if trait.ID == 'piece': 
                     trait["gpid"] = newPid
                     trait["lpid"] = newPid
-        
+                
         we do not actually change anything in the DOM.  To do that, we
-        must add back _all_ the traits as
-        
+        must add back _all_ the traits as::
+
             piece.setTraits(traits)
         
-        We can add traits to a piece, like
-        
+        We can add traits to a piece, like::
+
             piece.addTrait(MarkTrait('Hello','World'))
-        
+                
         But it is not particularly efficient.  Better to do
-        (continuing from above)
-        
+        (continuing from above)::
+
+       
             traits.append(MarkTrait('Hello','World;)
             piece.setTraits(traits)
+       
         
-        .. include:: ../../vassal/traits/README.md
+        .. include:: traits/README.md
            :parser: myst_parser.sphinx_
         
         '''

pywargame/vassal/traits/area.py

@@ -40,8 +40,10 @@ class AreaTrait(Trait):
                  onKey             = onKey,
                  offMenuText       = offMenuText,
                  offKey            = offKey,
-                 globallyVisible   = globallyVisible
-        )
+                 globallyVisible   = globallyVisible)
+        '''Create an area effect trait
+
+        '''
         self.setState(active = alwaysActive or not globallyVisible)
 
 Trait.known_traits.append(AreaTrait)

pywargame/vassal/traits/cargo.py

@@ -14,6 +14,9 @@ class CargoTrait(Trait):
                  detectionDistanceY     = 0,
                  attachKey              = '',
                  detachKey              = ''):
+        '''Create cargo trait
+
+        '''
         self.setType(description            = description,
                      maintainRelativeFacing = maintainRelativeFacing,
                      detectionDistanceX     = detectionDistanceX,

pywargame/vassal/traits/mat.py

@@ -10,6 +10,9 @@ class MatTrait(Trait):
     def __init__(self,
                  name = 'Mat',
                  description = ''):
+        '''Create mat trait
+
+        '''
         self.setType(name        = name,
                      description = description)
         self.setState(content='0')

pywargame/vassal/vmod.py

@@ -3,7 +3,7 @@
 # Wrapper around a module 
 #
 ## BEGIN_IMPORT
-from . xml import xmlns
+from . xmlns import xmlns
 ## END_IMPORT
 
 class VMod:

pywargame/zuntzu/__init__.py

@@ -1,4 +1,13 @@
 #
+from . base         import *
+from . dicehand     import *
+from . piece        import *
+from . map          import *
+from . scenario     import *
+from . countersheet import *
+from . gamebox      import *
+from . exporter     import *
+from . ztexp        import *
 
 #
 # EOF

pywargame/zuntzu/countersheet.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORTS
-from / base import DomInspect, ZTImage
+from . base import DomInspect, ZTImage
 from . piece import ZTPiece
 from pywargame.common import VerboseGuard
 ## END_IMPORTS

pywargame/zuntzu/ztexp.py

@@ -1,15 +1,13 @@
 #!/usr/bin/env python
 ## BEGIN_IMPORTS
-from sys import path
-path.append('..')
-
-from gamebox import ZTGameBox
-from exporter import ZTExporter
-from common      import Verbose
-from base import ZTImage
+from pywargame.zuntzu.gamebox  import ZTGameBox
+from pywargame.zuntzu.exporter import ZTExporter
+from pywargame.common          import Verbose
+from pywargame.zuntzu.base     import ZTImage
 ## END_IMPORTS
 
-if __name__ == '__main__':
+# ====================================================================
+def exportMain():
     from argparse import ArgumentParser, FileType, \
          RawDescriptionHelpFormatter 
     from pathlib import Path
@@ -109,6 +107,10 @@ if __name__ == '__main__':
             pass
 
         raise e
+    
+# ====================================================================
+if __name__ == '__main__':
+    exportMain()
         
 #
 # EOF