Clean-up setup.py, README etc.

Author: hwiedPro

Makefile

@@ -15,14 +15,10 @@ help:
 		@echo 	'  format    - Formats the python code in the folder using the black code'
 		@echo 	'              formatter (github.com/ambv/black).'
 		@echo 	'  help      - Print this help information.'
-		@echo 	'  init      - Install the Phobos requirements using pip.'
 		@echo	'  install   - Install the Phobos code to your Blender installation.'
 		@echo	'              This also sets up the configuration folder for Phobos.'
 		@echo	'  version   - Prints some help relating to drafting a new version.'
 
-init:
-		pip3 install -r requirements.txt
-
 install:
 		pip3 install .
 

README.md

@@ -59,19 +59,14 @@ After installation the phobos main menu can be found on the right hand side of t
 
 ![Small arrow to open the phobos toolbar widget.](https://github.com/dfki-ric/phobos/wiki/img/blender_phobos_menu_open.png)
 
-Phobos is currently tested and running with Blender v3.2.
+Phobos is currently tested and running with Blender v3.3 LTS.
 
 ### CLI
 Just install it using pip:
 ```bash
 cd phobos
 pip install .
 ```
-or without pip:
-```bash
-cd phobos
-python setup.py install
-```
 or with autoproj:
 1) Add the package to your buildconf/package_set
 2) Install via `amake`
@@ -120,7 +115,8 @@ It will also tell you which dependencies are missing for some scripts.
 ## Features
 
 - WYSIWYG editor for robot models using Blender
-- CLI tool for automated model processing
+- CLI tools for fast and easy model handling and inspection
+- CI tool to run phobos headless in your CI-pipeline for atomated model processing and maintenance
 - Import and export of **URDF**, **SDF** **SMURF** and other
   [formats](https://github.com/dfki-ric/phobos/wiki/Formats)
 - Easy definition of robot kinematics (links and joints)

blender_requirements.json

@@ -11,3 +11,15 @@ @misc{phobosrepo
   year = {2019},
   howpublished = {\url{https://github.com/dfki-ric/phobos}}
 }
+
+@article{Szadkowski2020,
+  url = {https://doi.org/10.21105/joss.01326},
+  year = {2020},
+  publisher = {The Open Journal},
+  volume = {5},
+  number = {45},
+  pages = {1326},
+  author = {Kai von Szadkowski and Simon Reichel},
+  title = {Phobos: A tool for creating complex robot models},
+  journal = {Journal of Open Source Software}
+}

get_blender_path.py

@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#!/usr/bin/python3
 
 # -------------------------------------------------------------------------------
 # This file is part of Phobos, a Blender Add-On to edit robot models.
@@ -9,12 +9,9 @@
 # -------------------------------------------------------------------------------
 import json
 import os
-import sys
-import shutil
 import setuptools
 import subprocess
 from pathlib import Path
-from copy import deepcopy
 
 
 # utilities
@@ -30,105 +27,27 @@ def get_git_branch():
     return subprocess.check_output(['git', 'rev-parse', '--abbrev-ref', 'HEAD']).strip().decode("utf-8")
 
 
-def check_blender_agreement(answer):
-    if not answer.lower() in ["y", "yes"]:
-        print("Blender installation cancelled!")
-        print("If you want to install the phobos blender "
-              "add-on later or manually follow the following steps:\n"
-              "1) Zip the phobos directory in this repository\n"
-              "2) Open blender\n"
-              "3) Go to preferences->Add-ons\n"
-              "4) Click 'Install' and select the freshly zipped phobos.zip file\n"
-              "   Blender will now install the phobos add-on with all its dependencies.\n"
-              "5) Click the checkbox to activate the phobos-add-on")
-        sys.exit()
-    return True
-
-
-def exec_shell_cmd(command):
-    if sys.platform.startswith("linux"):
-        command = [" ".join(str(x) for x in command)]
-    proc = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
-    (out, err) = proc.communicate()
-    return out.decode().strip()
-
-
-def install_requirement(py_exec, package_name, upgrade_pip=False, lib=None):
-    # Ensure pip is installed
-    exec_shell_cmd([py_exec, "-m", "ensurepip", "--user"])
-    # Update pip (not mandatory)
-    if upgrade_pip:
-        print("  Upgrading pip...")
-        exec_shell_cmd([py_exec, "-m", "pip", "install", "--upgrade", "pip"])
-    # Install package
-    print("  Installing package", package_name)
-    if lib is None:
-        exec_shell_cmd([py_exec, "-m", "pip", "install", package_name])
-    else:
-        exec_shell_cmd([py_exec, "-m", "pip",  "install", f"--target={str(lib)}", package_name])
-
-
-def check_requirements(py_exec, optional=False, upgrade_pip=False, lib=None):
-    print("Checking requirements:")
-    import importlib
-    requirements = [
-        "networkx",
-        "numpy",
-        "scipy",
-        "trimesh",
-        "pydot",
-        "setuptools",
-        "collada"
-    ]
-    optional_requirements = [
-        "pyyaml",
-        "pybullet",
-        "open3d",
-        "python-fcl"
-    ]
-    reqs = [requirements]
-    if optional:
-        reqs += [optional_requirements]
-    if upgrade_pip:
-        print("  Upgrading pip...")
-        exec_shell_cmd([py_exec, "-m", "pip", "install", "--upgrade", "pip"])
-    for r in reqs:
-        for import_name, req_name in r.items():
-            print("  Checking", import_name)
-            install_requirement(py_exec, req_name, upgrade_pip=False, lib=lib)
-            # try:
-            #     if importlib.util.find_spec(import_name) is None:
-            #         install_requirement(py_exec, req_name, upgrade_pip=False, lib=lib)
-            # except AttributeError:
-            #     loader = importlib.find_loader(import_name)
-            #     if not issubclass(type(loader), importlib.machinery.SourceFileLoader):
-            #         install_requirement(py_exec, req_name, upgrade_pip=False, lib=lib)
-    importlib.invalidate_caches()
-
-
-def fetch_path_from_blender_script(blender_exec, script, keyword="blender"):
-    out = exec_shell_cmd([blender_exec, "--background", "--python", script])
-    path = None
-    for line in out.split("\n"):
-        line = line.strip()
-        if line == "":
-            continue
-        if line.endswith("\r"):
-            line = line.replace("\r", "")
-        if line.startswith("/") and keyword in line.lower():
-            path = Path(line)
-            break
-    return path
-
-
 def main(args):
     # data
     with open("README.md", "r") as fh:
         long_description = fh.read()
     codemeta = json.load(open("codemeta.json", "r"))
-    deps = json.load(open("blender_requirements.json", "r"))
-    requirements = deps["requirements"]
-    optional_requirements = deps["optional_requirements"]
+    requirements = {
+        "yaml": "pyyaml",
+        "networkx": "networkx",  # optional for blender
+        "numpy": "numpy",
+        "scipy": "scipy",
+        "trimesh": "trimesh",  # optional for blender
+        "pkg_resources": "setuptools",
+        "collada": "pycollada",
+        "pydot": "pydot"
+    }
+    optional_requirements = {
+        "yaml": "pyyaml",
+        "pybullet": "pybullet",  # optional for blender
+        "open3d": "open3d",  # optional for blender
+        "python-fcl": "python-fcl",  # optional for blender
+    }
     this_dir = Path(__file__).parent
 
     ##################
@@ -160,53 +79,15 @@ def main(args):
             ]
         }
     }
-    # # autoproj handling
-    # if not "AUTOPROJ_CURRENT_ROOT" in os.environ:
-    #     kwargs["install_requires"] = list(requirements.values()) #+ list(optional_requirements.keys())
+    # autoproj handling
+    if not "AUTOPROJ_CURRENT_ROOT" in os.environ:
+        kwargs["install_requires"] = list(requirements.values())
+        kwargs["extras_require"] = {'console_scripts': list(optional_requirements.keys())}
 
     setuptools.setup(
         **kwargs
     )
 
-    if "--blender" in args:
-        #################
-        # blender addon #
-        #################
-        # autoproj installation can not handle user inputs
-        if "AUTOPROJ_CURRENT_ROOT" in os.environ:
-            sys.exit()
-
-        blender_path = None
-        print("Thanks for installing phobos!\n\nTrying now to install blender addon")
-        auto_found = False
-        for cmd in ["which", "where", "Get-Command"]:
-            out = Path(exec_shell_cmd([cmd, "blender"]))
-            if out.exists() and "blender" in str(out).lower():
-                if input(f"Take this blender version '{out}'? (y/n)>").lower() in ["y", "yes"]:
-                    auto_found = True
-                break
-        while not auto_found or not out.exists() or not "blender" in str(out).lower():
-            auto_found = True
-            print("Could not retrieve blender executable from this path:", out)
-            out = Path(input("Please provide the path to your blender executable: ").strip())
-        blender_path = deepcopy(out)
-        scripts_path = fetch_path_from_blender_script(blender_path, this_dir/"get_blender_path.py")
-        modules_path = scripts_path / "modules"
-        addons_path = scripts_path / "addons"
-        print("Found the following blender installation directories:")
-        print(scripts_path)
-        print(modules_path)
-        print(addons_path)
-        if check_blender_agreement(input("Do you want to proceed? (y/n)>").strip()):
-            #install phobos
-            target = addons_path/"phobos"
-            if target.exists():
-                shutil.rmtree(target)
-            shutil.copytree(this_dir/"phobos", target)
-            # install requirements
-            python_path = fetch_path_from_blender_script(blender_path, this_dir/"get_blender_python.py")
-            check_requirements(python_path, upgrade_pip=True, lib=modules_path)
-
 
 if __name__ == "__main__":
     import sys