pk3make 1.1__tar.gz → 1.1.2__tar.gz

{pk3make-1.1 → pk3make-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pk3make
-Version: 1.1
+Version: 1.1.2
 Summary: Build system for Weissblatt PK3 files
 Project-URL: Homepage, https://github.com/liquidunderground/pk3make
 Project-URL: GitHub, https://github.com/liquidunderground/pk3make
@@ -25,18 +25,33 @@ Description-Content-Type: text/markdown
 
 ## Installation
 
-1. Set up a [virtual environment](https://docs.python.org/3/library/venv.html)
-2. Install dependencies `pip install -r requirements.txt`
+0. Set up a [virtual environment](https://docs.python.org/3/library/venv.html)
+1. Install PK3Make: `pip install pk3make`
+2. ???
+3. Profits
 
 ## How to use
 
-PK3Make supplies multiple subcommands. To get an overview type:
+To fully build your project, simply run:
 
-    ./pk3make.py --help
+    pk3make
+	
+To get an overview of options for PK3Make, type:
 
-To fully build your project akin to a makefile, simply type:
+    pk3make --help
+	
+	
+By default, will use `./PK3Makefile` for it's PK3Makefile. Other can be given through `pk3make [PK3MAKEFILE]`. More on PK3Makefiles in the PK3Makefile reference below.
+
+### Build steps
+
+PK3Makefile defines four subcommands, each with their own unique options:
+
+1. `pk3make clean`: Clean & remove the build directory
+2. `pk3make build`: Compile the build directory.
+3. `pk3make pack`: Assemble a PK3 file from the build directory's contents
+4. `pk3make all`: Build and pack (Default).
 
-    ./pk3make.py make ./PK3Makefile # Default PK3Makefile
 
 ### Notes, Tips and Caveats
 

{pk3make-1.1 → pk3make-1.1.2}/README.md

@@ -4,18 +4,33 @@
 
 ## Installation
 
-1. Set up a [virtual environment](https://docs.python.org/3/library/venv.html)
-2. Install dependencies `pip install -r requirements.txt`
+0. Set up a [virtual environment](https://docs.python.org/3/library/venv.html)
+1. Install PK3Make: `pip install pk3make`
+2. ???
+3. Profits
 
 ## How to use
 
-PK3Make supplies multiple subcommands. To get an overview type:
+To fully build your project, simply run:
 
-    ./pk3make.py --help
+    pk3make
+	
+To get an overview of options for PK3Make, type:
 
-To fully build your project akin to a makefile, simply type:
+    pk3make --help
+	
+	
+By default, will use `./PK3Makefile` for it's PK3Makefile. Other can be given through `pk3make [PK3MAKEFILE]`. More on PK3Makefiles in the PK3Makefile reference below.
+
+### Build steps
+
+PK3Makefile defines four subcommands, each with their own unique options:
+
+1. `pk3make clean`: Clean & remove the build directory
+2. `pk3make build`: Compile the build directory.
+3. `pk3make pack`: Assemble a PK3 file from the build directory's contents
+4. `pk3make all`: Build and pack (Default).
 
-    ./pk3make.py make ./PK3Makefile # Default PK3Makefile
 
 ### Notes, Tips and Caveats
 

{pk3make-1.1 → pk3make-1.1.2}/src/pk3make/__main__.py

@@ -17,7 +17,7 @@ def prepare(workdir="build"):
 
 def cr_build_lump(lock, lumpdef, context):
     import shutil,os,re
-    from modules import doompic
+    from .modules import doompic
 
     bytedump = None
 
@@ -61,7 +61,7 @@ def cr_build_lump(lock, lumpdef, context):
                 ofile.write(bytedump)
 
 def get_palette(lock, lumpname, opts, pdict):
-    from modules import doompic, doomglob
+    from .modules import doompic, doomglob
     import os
 
     lock.acquire()
@@ -83,7 +83,7 @@ def get_palette(lock, lumpname, opts, pdict):
 
 
 def build(makefile):
-    from modules import doompic, doomglob
+    from .modules import doompic, doomglob
     from natsort import natsorted, ns
     import shutil, os, re
     import asyncio, concurrent.futures, multiprocessing
@@ -145,7 +145,7 @@ def build(makefile):
     return
 
 def pack(makefile):
-    from modules import pk3zip, doomglob
+    from .modules import pk3zip, doomglob
     from natsort import natsorted, ns
     import io, os, hashlib, pathlib, re
 
@@ -224,7 +224,7 @@ def pack(makefile):
     return
 
 def main():
-    from modules import pk3makefile
+    from .modules import pk3makefile
 
     # Step switches
     step_prepare = False
@@ -265,33 +265,27 @@ def main():
 
     return
 
-if __name__ == "__main__":
-    import argparse
-    import pathlib
-
-    # Shell argument API
-    verbs = [
-        'clean', # Delete workdir
-        'prepare', # Make workdir tree etc.
-        'build', # Convert formats & copy files to workdir according to METAINFO
-        'pack', # Pack existing workdir into pk3. (May be used for music packs?)
-        'all', # Do everything
-    ]
-    ap_main = argparse.ArgumentParser(
-            prog='pk3make',
-            description='PK3Make - Make for (Weissblatt) PK3s',
-            epilog='Type `pk3make --help` for more info.')
-    ap_sub = ap_main.add_subparsers(title='Build steps', dest='verb', metavar="")
-    
-    ap_clean = ap_sub.add_parser('clean', help='Delete the build directory')
-    ap_build = ap_sub.add_parser('build', help='Compile assets into the build directory')
-    ap_pack = ap_sub.add_parser('pack', help='Assemble a PK3 file from the build directory')
+### CLI Interface ###
 
-    ap_main.add_argument('-v', '--verbose' , action='store_true', help='Verbose log output')
-    ap_build.add_argument('target', nargs='?', help='Target LUMPDEF')
-    
-    ap_main.add_argument('makefile', nargs='?', const='./PK3Makefile', help='PK3Makefile to reference')
-    
-    args = ap_main.parse_args()
+import argparse
+import pathlib
+
+ap_main = argparse.ArgumentParser(
+        prog='pk3make',
+        description='PK3Make - Make for (Weissblatt) PK3s',
+        epilog='Type `pk3make --help` for more info.')
+ap_sub = ap_main.add_subparsers(title='Build steps', dest='verb', metavar="")
 
+ap_clean = ap_sub.add_parser('clean', help='Delete the build directory')
+ap_build = ap_sub.add_parser('build', help='Compile assets into the build directory')
+ap_pack = ap_sub.add_parser('pack', help='Assemble a PK3 file from the build directory')
+
+ap_main.add_argument('-v', '--verbose' , action='store_true', help='Verbose log output')
+ap_build.add_argument('target', nargs='?', help='Target LUMPDEF')
+
+ap_main.add_argument('makefile', nargs='?', const='./PK3Makefile', help='PK3Makefile to reference')
+
+args = ap_main.parse_args()
+
+if __name__ == "__main__":
     main()