Added setup.py to enable installation to user or system directory using setuptools

Re-structured directory tree to permit setuptools installation
Added "main" function definition in pico_project.py to permit executable installation using setuptools
Updated pico_configs.tsv configuration file read function to read from python script installation directory

Author: rikwade

logo_alpha.gif renamed to pico_project/logo_alpha.gif

@@ -1080,8 +1080,11 @@ def generateProjectFiles(projectPath, projectName, sdkPath, projects, debugger):
 
 
 def LoadConfigurations():
+    # open the pico_configs.tsv from the executable's directory
+    this_module_location = os.path.dirname(os.path.realpath(__file__))
+    tsv_file = os.path.join(this_module_location, "pico_configs.tsv")
     try:
-        with open("pico_configs.tsv") as tsvfile:
+        with open(tsv_file) as tsvfile:
             reader = csv.DictReader(tsvfile, dialect='excel-tab')
             for row in reader:
                 configuration_dictionary.append(row)
@@ -1180,70 +1183,74 @@ def DoEverything(parent, params):
 
 ###################################################################################
 # main execution starteth here
+def main():
+    args = ParseCommandLine()
 
-args = ParseCommandLine()
-
-if args.nouart:
-    args.uart = False
+    if args.nouart:
+        args.uart = False
 
 #  TODO this could be better, need some constants etc
-if args.debugger > 1:
-    args.debugger = 0
+    if args.debugger > 1:
+        args.debugger = 0
 
 # Check we have everything we need to compile etc
-c = CheckPrerequisites()
+    c = CheckPrerequisites()
 
 ## TODO Do both warnings in the same error message so user does have to keep coming back to find still more to do
 
-if c == None:
-    m = 'Unable to find the `' + COMPILER_NAME + '` compiler\n'
-    m +='You will need to install an appropriate compiler to build a Raspberry Pi Pico project\n'
-    m += 'See the Raspberry Pi Pico documentation for how to do this on your particular platform\n'
+    if c == None:
+        m = 'Unable to find the `' + COMPILER_NAME + '` compiler\n'
+        m +='You will need to install an appropriate compiler to build a Raspberry Pi Pico project\n'
+        m += 'See the Raspberry Pi Pico documentation for how to do this on your particular platform\n'
 
-    if (args.gui):
-        RunWarning(m)
-    else:
-        print(m)
-    sys.exit(-1)
+        if (args.gui):
+            RunWarning(m)
+        else:
+            print(m)
+        sys.exit(-1)
 
-if args.name == None and not args.gui and not args.list and not args.configs:
-    print("No project name specfied\n")
-    sys.exit(-1)
+    if args.name == None and not args.gui and not args.list and not args.configs:
+        print("No project name specfied\n")
+        sys.exit(-1)
 
 # load/parse any configuration dictionary we may have
-LoadConfigurations()
+    LoadConfigurations()
 
-p = CheckSDKPath(args.gui)
+    p = CheckSDKPath(args.gui)
 
-if p == None:
-    sys.exit(-1)
+    if p == None:
+        sys.exit(-1)
 
-sdkPath = Path(p)
+    sdkPath = Path(p)
 
-if args.gui:
-    RunGUI(sdkPath, args) # does not return, only exits
+    if args.gui:
+        RunGUI(sdkPath, args) # does not return, only exits
 
-projectRoot = Path(os.getcwd())
+    projectRoot = Path(os.getcwd())
 
-if args.list or args.configs:
-    if args.list:
-        print("Available project features:\n")
-        for feat in features_list:
-            print(feat.ljust(6), '\t', features_list[feat][GUI_TEXT])
-        print('\n')
+    if args.list or args.configs:
+        if args.list:
+            print("Available project features:\n")
+            for feat in features_list:
+                print(feat.ljust(6), '\t', features_list[feat][GUI_TEXT])
+            print('\n')
 
-    if args.configs:
-        print("Available project configuration items:\n")
-        for conf in configuration_dictionary:
-            print(conf['name'].ljust(40), '\t', conf['description'])
-        print('\n')
+        if args.configs:
+            print("Available project configuration items:\n")
+            for conf in configuration_dictionary:
+                print(conf['name'].ljust(40), '\t', conf['description'])
+            print('\n')
+
+        sys.exit(0)
+    else :
+        p = Parameters(sdkPath=sdkPath, projectRoot=projectRoot, projectName=args.name,
+                    gui=False, overwrite=args.overwrite, build=args.build, features=args.feature,
+                    projects=args.project, configs=(), runFromRAM=args.runFromRAM,
+                    examples=args.examples, uart=args.uart, usb=args.usb, cpp=args.cpp, debugger=args.debugger, exceptions=args.cppexceptions, rtti=args.cpprtti)
+
+        DoEverything(None, p)
 
-    sys.exit(0)
-else :
-    p = Parameters(sdkPath=sdkPath, projectRoot=projectRoot, projectName=args.name,
-                   gui=False, overwrite=args.overwrite, build=args.build, features=args.feature,
-                   projects=args.project, configs=(), runFromRAM=args.runFromRAM,
-                   examples=args.examples, uart=args.uart, usb=args.usb, cpp=args.cpp, debugger=args.debugger, exceptions=args.cppexceptions, rtti=args.cpprtti)
 
-    DoEverything(None, p)
+if __name__ == "__main__":
+    main()
 

pico_configs.tsv renamed to pico_project/pico_configs.tsv

@@ -0,0 +1,29 @@
+import setuptools
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setuptools.setup (
+    name = "pico-project-generator",
+    version = "0.1",
+    description = "Console and GUI CMake project generator for the Raspberry Pi Pico",
+    long_description = long_description,
+    long_description_content_type = "text/markdown",
+    url = "https://github.com/raspberrypi/pico-project-generator",
+    classifiers=[
+        "Programming Language :: Python :: 3",
+    ],
+    python_requires = '>=3.6',
+    use_scm_version = True,
+    setup_requires=['setuptools_scm'],
+    package_data = {
+        'pico_project': ['logo_alpha.gif', 'pico_configs.tsv']
+    },
+    packages = ["pico_project"],
+    entry_points = {
+        'console_scripts': [
+            'pico_project=pico_project.pico_project:main',
+        ],
+    }
+)
+