partcad-cli 0.3.1__tar.gz

partcad-cli-0.3.1/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.1
+Name: partcad-cli
+Version: 0.3.1
+Summary: Command-line interface to PartCAD
+Author-email: Roman Kuzmenko <openvmp@proton.me>
+Maintainer-email: Roman Kuzmenko <openvmp@proton.me>
+Project-URL: Homepage, https://github.com/openvmp/partcad
+Project-URL: Issues, https://github.com/openvmp/partcad/issues
+Keywords: cadquery,build123d,cad,design,openscad,step,stl
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: partcad==0.3.1
+Requires-Dist: pycairo
+Requires-Dist: renderlab
+Requires-Dist: rlPyCairo
+Requires-Dist: svglib
+Requires-Dist: ocp_vscode
+Requires-Dist: progress

partcad-cli-0.3.1/pyproject.toml

@@ -0,0 +1,34 @@
+[project]
+name = "partcad-cli"
+version = "0.3.1"
+description = "Command-line interface to PartCAD"
+readme = "README.md"
+keywords = ["cadquery", "build123d", "cad", "design", "openscad", "step", "stl"]
+requires-python = ">=3.7"
+license = {file = "LICENSE.txt"}
+authors = [
+  {name = "Roman Kuzmenko", email = "openvmp@proton.me" }
+]
+maintainers = [
+  {name = "Roman Kuzmenko", email = "openvmp@proton.me" }
+]
+dynamic = ["dependencies"]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+]
+
+[tool.setuptools.package-data]
+"partcad_cli.template" = ["*.yaml"]
+
+[project.scripts]
+pc = "partcad_cli:main_cli"
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
+[project.urls]
+Homepage = "https://github.com/openvmp/partcad"
+Issues = "https://github.com/openvmp/partcad/issues"

partcad-cli-0.3.1/requirements.txt

@@ -0,0 +1,7 @@
+partcad==0.3.1
+pycairo
+renderlab
+rlPyCairo
+svglib
+ocp_vscode
+progress

partcad-cli-0.3.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

partcad-cli-0.3.1/src/partcad_cli/__init__.py

@@ -0,0 +1,7 @@
+from .cli import main as main_cli
+
+__all__ = [
+    "main_cli",
+]
+
+__version__: str = "0.3.1"

partcad-cli-0.3.1/src/partcad_cli/cli.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python
+#
+# OpenVMP, 2023
+#
+# Author: Roman Kuzmenko
+# Created: 2023-12-22
+#
+# Licensed under Apache License, Version 2.0.
+#
+
+import argparse
+import logging
+
+import partcad as pc
+
+from .cli_add import *
+from .cli_init import *
+from .cli_install import *
+from .cli_list import *
+from .cli_render import *
+from .cli_show import *
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="PartCAD command line tool",
+    )
+    parser.add_argument(
+        "-p",
+        help="Package path (a YAML file or a directory with 'partcad.yaml')",
+        type=str,
+        default=None,
+        dest="config_path",
+    )
+    # TODO(clairbee): add a config option to change logging mechanism and level
+    subparsers = parser.add_subparsers(dest="command")
+    cli_help_add(subparsers)
+    cli_help_init(subparsers)
+    cli_help_install(subparsers)
+    cli_help_list(subparsers)
+    cli_help_render(subparsers)
+    cli_help_show(subparsers)
+
+    args = parser.parse_args()
+
+    logging.basicConfig(level=logging.INFO)
+
+    if args.command == "add":
+        cli_add(args)
+
+    elif args.command == "init":
+        cli_init(args)
+
+    elif args.command == "install":
+        cli_install(args)
+
+    elif args.command == "list":
+        cli_list(args)
+
+    elif args.command == "list-all":
+        cli_list_assemblies(args)
+        cli_list_parts(args)
+
+    elif args.command == "list-parts":
+        cli_list_parts(args)
+
+    elif args.command == "list-assemblies":
+        cli_list_assemblies(args)
+
+    elif args.command == "render":
+        cli_render(args)
+
+    elif args.command == "show":
+        cli_show(args)
+
+    else:
+        print("Unknown command.\n")
+        parser.print_help()
+
+
+if __name__ == "__main__":
+    main()

partcad-cli-0.3.1/src/partcad_cli/cli_add.py

@@ -0,0 +1,66 @@
+#
+# OpenVMP, 2023
+#
+# Author: Roman Kuzmenko
+# Created: 2023-12-23
+#
+# Licensed under Apache License, Version 2.0.
+#
+
+import logging
+import os
+import ruamel.yaml
+import sys
+
+import partcad as pc
+
+
+def cli_help_add(subparsers):
+    parser_add = subparsers.add_parser(
+        "add",
+        help="Import a package",
+    )
+    parser_add.add_argument(
+        "alias",
+        help="Alias to be used to reference the package",
+        type=str,
+    )
+    parser_add.add_argument(
+        "location",
+        help="Path or URL to the package",
+        type=str,
+    )
+
+
+def cli_add(args):
+    if not os.path.exists("partcad.yaml"):
+        logging.error("'partcad.yaml' not found!")
+        sys.exit(1)
+
+    if ":" in args.location:
+        location_param = "url"
+        if args.location.endswith(".tar.gz"):
+            location_type = "tar"
+        else:
+            location_type = "git"
+    else:
+        location_param = "path"
+        location_type = "local"
+
+    yaml = ruamel.yaml.YAML()
+    yaml.preserve_quotes = True
+    with open("partcad.yaml") as fp:
+        config = yaml.load(fp)
+        fp.close()
+
+    for elem in config:
+        if elem == "import":
+            imports = config["import"]
+            imports[args.alias] = {
+                location_param: args.location,
+                "type": location_type,
+            }
+            break  # no need to iterate further
+    with open("partcad.yaml", "w") as fp:
+        yaml.dump(config, fp)
+        fp.close()

partcad-cli-0.3.1/src/partcad_cli/cli_init.py

@@ -0,0 +1,49 @@
+#
+# OpenVMP, 2023
+#
+# Author: Roman Kuzmenko
+# Created: 2023-12-23
+#
+# Licensed under Apache License, Version 2.0.
+#
+
+import logging
+import os
+import shutil
+import sys
+
+import partcad as pc
+
+
+def cli_help_init(subparsers):
+    parser_init = subparsers.add_parser(
+        "init",
+        help="Initialize new PartCAD package in this directory",
+    )
+    parser_init.add_argument(
+        "-p",
+        help="Initialize this package as private",
+        dest="private",
+        action="store_true",
+    )
+
+
+def cli_init(args):
+    if args.private:
+        template_name = "init-private.yaml"
+    else:
+        template_name = "init-public.yaml"
+    src_path = os.path.join(os.path.dirname(__file__), "template", template_name)
+
+    if not args.config_path is None:
+        if os.path.isdir(args.config_path):
+            dst_path = os.path.join(args.config_path, "partcad.yaml")
+        else:
+            dst_path = args.config_path
+    else:
+        dst_path = "partcad.yaml"
+
+    if os.path.exists(dst_path):
+        logging.error("'%s' already exists!" % dst_path)
+        sys.exit(1)
+    shutil.copyfile(src_path, dst_path)

partcad-cli-0.3.1/src/partcad_cli/cli_install.py

@@ -0,0 +1,24 @@
+#
+# OpenVMP, 2023
+#
+# Author: Roman Kuzmenko
+# Created: 2023-12-23
+#
+# Licensed under Apache License, Version 2.0.
+#
+
+import partcad as pc
+
+
+def cli_help_install(subparsers):
+    parser_install = subparsers.add_parser(
+        "install",
+        help="Download and prepare all imported packages",
+    )
+
+
+def cli_install(args):
+    if not args.config_path is None:
+        pc.init(args.config_path)
+    else:
+        pc.init()

partcad-cli-0.3.1/src/partcad_cli/cli_list.py

@@ -0,0 +1,216 @@
+#
+# OpenVMP, 2023
+#
+# Author: Roman Kuzmenko
+# Created: 2023-12-23
+#
+# Licensed under Apache License, Version 2.0.
+#
+
+import logging
+import partcad as pc
+
+
+def cli_help_list(subparsers):
+    parser_list = subparsers.add_parser(
+        "list",
+        help="List imported packages",
+    )
+    parser_list_all = subparsers.add_parser(
+        "list-all",
+        help="List available parts, assemblies and scenes",
+    )
+    parser_list_parts = subparsers.add_parser(
+        "list-parts",
+        help="List available parts",
+    )
+    parser_list_assemblies = subparsers.add_parser(
+        "list-assemblies",
+        help="List available assemblies",
+    )
+
+    parser_list_all.add_argument(
+        "-r",
+        help="Recursively process all imported packages",
+        dest="recursive",
+        action="store_true",
+    )
+    parser_list_parts.add_argument(
+        "-r",
+        help="Recursively process all imported packages",
+        dest="recursive",
+        action="store_true",
+    )
+    parser_list_assemblies.add_argument(
+        "-r",
+        help="Recursively process all imported packages",
+        dest="recursive",
+        action="store_true",
+    )
+
+    parser_list_all.add_argument(
+        "-u",
+        help="Only process objects used by the given assembly or scene.",
+        dest="used_by",
+        type=str,
+        required=False,
+    )
+    parser_list_parts.add_argument(
+        "-u",
+        help="Only process objects used by the given assembly or scene.",
+        dest="used_by",
+        type=str,
+        required=False,
+    )
+    parser_list_assemblies.add_argument(
+        "-u",
+        help="Only process objects used by the given assembly or scene.",
+        dest="used_by",
+        type=str,
+        required=False,
+    )
+
+
+def cli_list(args):
+    if not args.config_path is None:
+        ctx = pc.init(args.config_path)
+    else:
+        ctx = pc.init()
+    pkg_count = 0
+
+    print()
+    print("PartCAD dependencies:")
+    for project_name in ctx.projects:
+        if project_name == pc.THIS or project_name.startswith("partcad-"):
+            continue
+
+        project = ctx.projects[project_name]
+        line = "\t%s" % project_name
+        padding_size = 40 - len(project_name)
+        if padding_size < 4:
+            padding_size = 4
+        line += " " * padding_size
+        line += "%s" % project.desc
+        print(line)
+        pkg_count = pkg_count + 1
+
+    if pkg_count < 1:
+        print("\t<none>")
+
+
+def cli_list_parts(args):
+    if not args.config_path is None:
+        ctx = pc.init(args.config_path)
+    else:
+        ctx = pc.init()
+    part_count = 0
+    part_kinds = 0
+
+    if args.used_by is not None:
+        print("Instantiating %s..." % args.used_by)
+        pc.get_assembly(args.used_by)
+
+    print()
+    print("PartCAD parts:")
+    for project_name in ctx.projects:
+        if project_name != pc.THIS and not args.recursive:
+            continue
+        if project_name.startswith("partcad-"):
+            continue
+        project = ctx.projects[project_name]
+
+        if args.used_by is None:
+            if (
+                "parts" in project.config_obj
+                and project.config_obj["parts"] is not None
+            ):
+                part_names = project.config_obj["parts"].keys()
+            else:
+                part_names = []
+        else:
+            part_names = project.parts.keys()
+        for part_name in part_names:
+            line = "\t"
+            if args.recursive:
+                line += "%s" % project_name
+                line += " " * (36 - len(project_name))
+            line += "%s" % part_name
+            if args.used_by is not None:
+                part = project.parts[part_name]
+                line += "(%d)" % part.count
+                part_count = part_count + part.count
+            line += " " * (36 - len(part_name))
+            if (
+                project.config_obj["parts"][part_name] is not None
+                and "desc" in project.config_obj["parts"][part_name]
+            ):
+                line += "%s" % project.config_obj["parts"][part_name]["desc"]
+            print(line)
+            part_kinds = part_kinds + 1
+
+    if part_kinds > 0:
+        if args.used_by is None:
+            print("Total: %d" % part_kinds)
+        else:
+            print("Total: %d parts of %d kinds" % (part_count, part_kinds))
+    else:
+        print("\t<none>")
+
+
+def cli_list_assemblies(args):
+    if not args.config_path is None:
+        ctx = pc.init(args.config_path)
+    else:
+        ctx = pc.init()
+    assy_count = 0
+    assy_kinds = 0
+
+    if args.used_by is not None:
+        print("Instantiating %s..." % args.used_by)
+        pc.get_assembly(args.used_by)
+
+    print()
+    print("PartCAD assemblies:")
+    for project_name in ctx.projects:
+        if project_name != pc.THIS and not args.recursive:
+            continue
+        if project_name.startswith("partcad-"):
+            continue
+        project = ctx.projects[project_name]
+
+        if args.used_by is None:
+            if (
+                "assemblies" in project.config_obj
+                and project.config_obj["assemblies"] is not None
+            ):
+                assy_names = project.config_obj["assemblies"].keys()
+            else:
+                assy_names = []
+        else:
+            assy_names = project.assemblies.keys()
+        for assy_name in assy_names:
+            line = "\t"
+            if args.recursive:
+                line += "%s" % project_name
+                line += " " * (36 - len(project_name))
+            line += "%s" % assy_name
+            if args.used_by is not None:
+                assy = project.assemblies[assy_name]
+                line += "(%d)" % assy.count
+                assy_count = assy_count + assy.count
+            line += " " * (36 - len(assy_name))
+            if (
+                project.config_obj["assemblies"][assy_name] is not None
+                and "desc" in project.config_obj["assemblies"][assy_name]
+            ):
+                line += "%s" % project.config_obj["assemblies"][assy_name]["desc"]
+            print(line)
+            assy_kinds = assy_kinds + 1
+
+    if assy_kinds > 0:
+        if args.used_by is None:
+            print("Total: %d" % assy_kinds)
+        else:
+            print("Total: %d assemblies of %d kinds" % (assy_count, assy_kinds))
+    else:
+        print("\t<none>")

partcad-cli-0.3.1/src/partcad_cli/cli_render.py

@@ -0,0 +1,76 @@
+#
+# OpenVMP, 2023-2024
+#
+# Author: Roman Kuzmenko
+# Created: 2023-12-23
+#
+# Licensed under Apache License, Version 2.0.
+#
+
+import argparse
+
+import partcad as pc
+
+
+def cli_help_render(subparsers: argparse.ArgumentParser):
+    parser_render = subparsers.add_parser(
+        "render",
+        help="Render the selected or all parts, assemblies and scenes in this package",
+    )
+    group_type = parser_render.add_mutually_exclusive_group(required=False)
+    group_type.add_argument(
+        "-a",
+        help="The object is an assembly",
+        dest="assembly",
+        action="store_true",
+    )
+    group_type.add_argument(
+        "-s",
+        help="The object is a scene",
+        dest="scene",
+        action="store_true",
+    )
+
+    parser_render.add_argument(
+        "object",
+        help="Part (default), assembly or scene to render",
+        type=str,
+        nargs="?",
+    )
+    # TODO(clairbee): make the package argument depending on the object argument
+    #                 [<object> [<package>]]
+    #                 instead of
+    #                 [<object>] [<package>]
+    parser_render.add_argument(
+        "package",
+        help="Package to retrieve the object from",
+        type=str,
+        nargs="?",
+    )
+
+
+def cli_render(args):
+    if not args.config_path is None:
+        ctx = pc.init(args.config_path)
+    else:
+        ctx = pc.init()
+
+    if args.package is None:
+        package = "this"
+    else:
+        package = args.package
+
+    if args.object is None:
+        # Render all parts and assemblies configured to be auto-rendered in this project
+        ctx.render()
+    else:
+        # Render the requested part or assembly
+        parts = []
+        assemblies = []
+        if args.assembly:
+            assemblies.append(args.object)
+        else:
+            parts.append(args.object)
+
+        prj = ctx.get_project(package)
+        prj.render(parts=parts, assemblies=assemblies)

partcad-cli-0.3.1/src/partcad_cli/cli_show.py

@@ -0,0 +1,71 @@
+#
+# OpenVMP, 2023
+#
+# Author: Roman Kuzmenko
+# Created: 2023-12-23
+#
+# Licensed under Apache License, Version 2.0.
+#
+
+import logging
+
+import partcad as pc
+
+
+def cli_help_show(subparsers):
+    parser_show = subparsers.add_parser(
+        "show",
+        help="Visualize a part, assembly or scene",
+    )
+    group_type = parser_show.add_mutually_exclusive_group(required=False)
+    group_type.add_argument(
+        "-a",
+        help="The object is an assembly",
+        dest="assembly",
+        action="store_true",
+    )
+    group_type.add_argument(
+        "-s",
+        help="The object is a scene",
+        dest="scene",
+        action="store_true",
+    )
+
+    parser_show.add_argument(
+        "object",
+        help="Part (default), assembly or scene to show",
+        type=str,
+    )
+    parser_show.add_argument(
+        "package",
+        help="Package to retrieve the object from",
+        type=str,
+        nargs="?",
+    )
+
+
+def cli_show(args):
+    if not args.config_path is None:
+        ctx = pc.init(args.config_path)
+    else:
+        ctx = pc.init()
+
+    if args.package is None:
+        package = "this"
+    else:
+        package = args.package
+
+    if args.assembly:
+        obj = ctx.get_assembly(args.object, package)
+    else:
+        obj = ctx.get_part(args.object, package)
+
+    if obj is None:
+        if args.package is None:
+            logging.error("Object %s not found" % args.object)
+        else:
+            logging.error(
+                "Object %s not found in package %s" % (args.object, args.package)
+            )
+    else:
+        obj.show()

partcad-cli-0.3.1/src/partcad_cli/template/init-private.yaml

@@ -0,0 +1,16 @@
+import:
+  # Add dependencies here
+  #     <package-name>:
+  #         desc: <package description>               # optional
+  #         type: <local|git|tar>
+  #         path: <relative path>                     # type:local only
+  #         url: <url of the package>                 # type:git|tar only
+  #         relPath: <relative path within the repo>  # type:git|tar only
+  #         web: <package's or maintainer's url>      # optional
+  #         poc: <maintainer's email>                 # optional
+
+parts:
+  # Add parts here
+
+assemblies:
+  # Add assemblies here

partcad-cli-0.3.1/src/partcad_cli/template/init-public.yaml

@@ -0,0 +1,19 @@
+import:
+  # Add dependencies here
+  #     <package-name>:
+  #         desc: <package description>               # optional
+  #         type: <local|git|tar>
+  #         path: <relative path>                     # type:local only
+  #         url: <url of the package>                 # type:git|tar only
+  #         relPath: <relative path within the repo>  # type:git|tar only
+  #         web: <package's or maintainer's url>      # optional
+  #         poc: <maintainer's email>                 # optional
+  partcad-index:
+    type: git
+    url: https://github.com/openvmp/partcad-index.git
+
+parts:
+  # Add parts here
+
+assemblies:
+  # Add assemblies here

partcad-cli-0.3.1/src/partcad_cli.egg-info/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.1
+Name: partcad-cli
+Version: 0.3.1
+Summary: Command-line interface to PartCAD
+Author-email: Roman Kuzmenko <openvmp@proton.me>
+Maintainer-email: Roman Kuzmenko <openvmp@proton.me>
+Project-URL: Homepage, https://github.com/openvmp/partcad
+Project-URL: Issues, https://github.com/openvmp/partcad/issues
+Keywords: cadquery,build123d,cad,design,openscad,step,stl
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: partcad==0.3.1
+Requires-Dist: pycairo
+Requires-Dist: renderlab
+Requires-Dist: rlPyCairo
+Requires-Dist: svglib
+Requires-Dist: ocp_vscode
+Requires-Dist: progress

partcad-cli-0.3.1/src/partcad_cli.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+pyproject.toml
+requirements.txt
+src/partcad_cli/__init__.py
+src/partcad_cli/cli.py
+src/partcad_cli/cli_add.py
+src/partcad_cli/cli_init.py
+src/partcad_cli/cli_install.py
+src/partcad_cli/cli_list.py
+src/partcad_cli/cli_render.py
+src/partcad_cli/cli_show.py
+src/partcad_cli.egg-info/PKG-INFO
+src/partcad_cli.egg-info/SOURCES.txt
+src/partcad_cli.egg-info/dependency_links.txt
+src/partcad_cli.egg-info/entry_points.txt
+src/partcad_cli.egg-info/requires.txt
+src/partcad_cli.egg-info/top_level.txt
+src/partcad_cli/template/init-private.yaml
+src/partcad_cli/template/init-public.yaml

partcad-cli-0.3.1/src/partcad_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

partcad-cli-0.3.1/src/partcad_cli.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pc = partcad_cli:main_cli

partcad-cli-0.3.1/src/partcad_cli.egg-info/requires.txt

@@ -0,0 +1,7 @@
+partcad==0.3.1
+pycairo
+renderlab
+rlPyCairo
+svglib
+ocp_vscode
+progress

partcad-cli-0.3.1/src/partcad_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+partcad_cli