partcad-cli 0.4.2__tar.gz → 0.5.1__tar.gz

partcad-cli-0.5.1/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.1
+Name: partcad-cli
+Version: 0.5.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.10
+Description-Content-Type: text/markdown
+Requires-Dist: partcad==0.5.1
+Requires-Dist: pycairo
+Requires-Dist: renderlab
+Requires-Dist: rlPyCairo
+Requires-Dist: svglib
+Requires-Dist: ocp_vscode
+
+# PartCAD <!-- omit in toc -->
+
+[![License](https://github.com/openvmp/partcad/blob/main/apache20.svg?raw=true)](./LICENSE.txt)
+
+[![CI on Linux, MacOS and Windows](https://github.com/openvmp/partcad/actions/workflows/python-test.yml/badge.svg)](https://github.com/openvmp/partcad/actions/workflows/python-test.yml)
+[![CD on Linux, MacOS and Windows](https://github.com/openvmp/partcad/actions/workflows/python-build.yml/badge.svg)](https://github.com/openvmp/partcad/actions/workflows/python-build.yml)
+[![Deployment to PyPI](https://github.com/openvmp/partcad/actions/workflows/python-deploy.yml/badge.svg)](https://github.com/openvmp/partcad/actions/workflows/python-deploy.yml)
+[![Documentation Status](https://readthedocs.org/projects/partcad/badge/?version=latest)](https://partcad.readthedocs.io/en/latest/?badge=latest)
+<a href="https://discord.gg/AXbP47zYw5"><img alt="Discord" src="https://img.shields.io/discord/1091497262733074534?logo=discord&logoColor=white&label=Discord&labelColor=353c43&color=31c151"></a>
+
+PartCAD is the first build system and package manager for CAD models,
+and a framework for creating assemblies.
+
+PartCAD allows to maintain information about mechanical parts,
+how they come together to form larger assemblies,
+and to reuse the same parts in multiple assemblies, multiple projects.
+The implementation of parts can change over time
+(e.g. optimize or migrate to [build123d] from [STEP]) without the need to update
+all of the consumers.
+
+Find [more documentation here](https://partcad.readthedocs.io/en/latest/?badge=latest).
+
+## Installation
+
+The recommended method to install PartCAD for most users is:
+
+```shell
+pip install partcad-cli
+```
+
+For contributors:
+
+```shell
+git clone https://github.com/openvmp/partcad.git
+cd partcad
+python3 -m pip install -e ./partcad
+python3 -m pip install -e ./partcad-cli
+```
+
+PartCAD works best when [conda](https://docs.conda.io/) is installed.
+If that doesn't help (e.g. MacOS+arm64) then try ``mamba``.
+On Windows, PartCAD requires at least a `conda` environment.
+
+## Architecture
+
+![Architecture](https://github.com/openvmp/partcad/blob/main/docs/source/architecture.png?raw=true)
+
+## Tools for mechanical engineering
+
+Here is an overview of the open source tools to maintain
+mechanical projects. It shows where does this framework fit
+in the modern mechanical development workflows.
+
+```mermaid
+flowchart TB
+
+subgraph repo["Your project's GIT repository"]
+  subgraph custom_repo["Custom parts"]
+    direction TB
+    custom_part_internet["A STEP file\ndownloaded from Internet\nor the vendor site"]
+    custom_part_cad["A part exported as a solid\nfrom a CAD tool not\nsuitable for collaboration"]
+    custom_part_cq["An individual reusable part\nmaintained as a script\nunder a version control system"]
+    custom_part_os["Another reusable part\nmaintained as a script\nunder a version control system"]
+  end
+
+  model["Your project's model defined\nas ASSY or Python code\nfor version control\nand collaboration"]
+
+  subgraph scenes["Scenes"]
+    test1["Capability 1\ntest scene"]
+    test2["Capability 2\ntest scene"]
+  end
+end
+
+subgraph external_repos["Third-party GIT repositories,\nCDN-hosted files or OCCI servers"]
+  subgraph external_repo["Repository of standard\nor popular parts"]
+  end
+end
+
+subgraph external_tools["External tools"]
+  freecad["FreeCAD"]
+  cadquery["CadQuery / build123d"]
+  openscad["OpenSCAD"]
+  gazebo["Gazebo"]
+
+  partcad["PartCAD library"]
+  style partcad fill:#c00
+end
+
+custom_part_cad <--- |Individual\ncontributor|freecad
+custom_part_cq <--- |Part design\nworkflow| cadquery
+custom_part_os <--- |Part design\nworkflow| openscad
+
+external_repo ---> |Import| model
+custom_repo ---> |Import| model
+model -.-> |Import| test1
+model -.-> |Import| test2
+
+custom_repo <-. Maintained\nusing\nPartCAD\nconvention .- partcad
+external_repo <-. Maintained\nusing\nPartCAD\nconvention .- partcad
+model <--- partcad
+test1 <--- partcad
+test2 <--- partcad
+
+test1 -.-> |Export| gazebo
+test2 -.-> |Export| gazebo
+```
+
+[CadQuery]: https://github.com/CadQuery/cadquery
+[build123d]: https://github.com/gumyr/build123d
+[STEP]: https://en.wikipedia.org/wiki/ISO_10303
+[OpenCASCADE]: https://www.opencascade.com/

partcad-cli-0.5.1/README.md

@@ -0,0 +1,111 @@
+# PartCAD <!-- omit in toc -->
+
+[![License](https://github.com/openvmp/partcad/blob/main/apache20.svg?raw=true)](./LICENSE.txt)
+
+[![CI on Linux, MacOS and Windows](https://github.com/openvmp/partcad/actions/workflows/python-test.yml/badge.svg)](https://github.com/openvmp/partcad/actions/workflows/python-test.yml)
+[![CD on Linux, MacOS and Windows](https://github.com/openvmp/partcad/actions/workflows/python-build.yml/badge.svg)](https://github.com/openvmp/partcad/actions/workflows/python-build.yml)
+[![Deployment to PyPI](https://github.com/openvmp/partcad/actions/workflows/python-deploy.yml/badge.svg)](https://github.com/openvmp/partcad/actions/workflows/python-deploy.yml)
+[![Documentation Status](https://readthedocs.org/projects/partcad/badge/?version=latest)](https://partcad.readthedocs.io/en/latest/?badge=latest)
+<a href="https://discord.gg/AXbP47zYw5"><img alt="Discord" src="https://img.shields.io/discord/1091497262733074534?logo=discord&logoColor=white&label=Discord&labelColor=353c43&color=31c151"></a>
+
+PartCAD is the first build system and package manager for CAD models,
+and a framework for creating assemblies.
+
+PartCAD allows to maintain information about mechanical parts,
+how they come together to form larger assemblies,
+and to reuse the same parts in multiple assemblies, multiple projects.
+The implementation of parts can change over time
+(e.g. optimize or migrate to [build123d] from [STEP]) without the need to update
+all of the consumers.
+
+Find [more documentation here](https://partcad.readthedocs.io/en/latest/?badge=latest).
+
+## Installation
+
+The recommended method to install PartCAD for most users is:
+
+```shell
+pip install partcad-cli
+```
+
+For contributors:
+
+```shell
+git clone https://github.com/openvmp/partcad.git
+cd partcad
+python3 -m pip install -e ./partcad
+python3 -m pip install -e ./partcad-cli
+```
+
+PartCAD works best when [conda](https://docs.conda.io/) is installed.
+If that doesn't help (e.g. MacOS+arm64) then try ``mamba``.
+On Windows, PartCAD requires at least a `conda` environment.
+
+## Architecture
+
+![Architecture](https://github.com/openvmp/partcad/blob/main/docs/source/architecture.png?raw=true)
+
+## Tools for mechanical engineering
+
+Here is an overview of the open source tools to maintain
+mechanical projects. It shows where does this framework fit
+in the modern mechanical development workflows.
+
+```mermaid
+flowchart TB
+
+subgraph repo["Your project's GIT repository"]
+  subgraph custom_repo["Custom parts"]
+    direction TB
+    custom_part_internet["A STEP file\ndownloaded from Internet\nor the vendor site"]
+    custom_part_cad["A part exported as a solid\nfrom a CAD tool not\nsuitable for collaboration"]
+    custom_part_cq["An individual reusable part\nmaintained as a script\nunder a version control system"]
+    custom_part_os["Another reusable part\nmaintained as a script\nunder a version control system"]
+  end
+
+  model["Your project's model defined\nas ASSY or Python code\nfor version control\nand collaboration"]
+
+  subgraph scenes["Scenes"]
+    test1["Capability 1\ntest scene"]
+    test2["Capability 2\ntest scene"]
+  end
+end
+
+subgraph external_repos["Third-party GIT repositories,\nCDN-hosted files or OCCI servers"]
+  subgraph external_repo["Repository of standard\nor popular parts"]
+  end
+end
+
+subgraph external_tools["External tools"]
+  freecad["FreeCAD"]
+  cadquery["CadQuery / build123d"]
+  openscad["OpenSCAD"]
+  gazebo["Gazebo"]
+
+  partcad["PartCAD library"]
+  style partcad fill:#c00
+end
+
+custom_part_cad <--- |Individual\ncontributor|freecad
+custom_part_cq <--- |Part design\nworkflow| cadquery
+custom_part_os <--- |Part design\nworkflow| openscad
+
+external_repo ---> |Import| model
+custom_repo ---> |Import| model
+model -.-> |Import| test1
+model -.-> |Import| test2
+
+custom_repo <-. Maintained\nusing\nPartCAD\nconvention .- partcad
+external_repo <-. Maintained\nusing\nPartCAD\nconvention .- partcad
+model <--- partcad
+test1 <--- partcad
+test2 <--- partcad
+
+test1 -.-> |Export| gazebo
+test2 -.-> |Export| gazebo
+```
+
+[CadQuery]: https://github.com/CadQuery/cadquery
+[build123d]: https://github.com/gumyr/build123d
+[STEP]: https://en.wikipedia.org/wiki/ISO_10303
+[OpenCASCADE]: https://www.opencascade.com/

{partcad-cli-0.4.2 → partcad-cli-0.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "partcad-cli"
-version = "0.4.2"
+version = "0.5.1"
 description = "Command-line interface to PartCAD"
 readme = "README.md"
 keywords = ["cadquery", "build123d", "cad", "design", "openscad", "step", "stl"]

{partcad-cli-0.4.2 → partcad-cli-0.5.1}/requirements.txt

@@ -1,4 +1,4 @@
-partcad==0.4.2
+partcad==0.5.1
 pycairo
 renderlab
 rlPyCairo

{partcad-cli-0.4.2 → partcad-cli-0.5.1}/src/partcad_cli/__init__.py

@@ -4,4 +4,4 @@ __all__ = [
     "main_cli",
 ]
 
-__version__: str = "0.4.2"
+__version__: str = "0.5.1"

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

@@ -0,0 +1,153 @@
+#!/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
+import partcad.logging as pc_logging
+from partcad.user_config import user_config
+
+from .cli_add import *
+from .cli_init import *
+from .cli_info import *
+from .cli_install import *
+from .cli_list import *
+from .cli_render import *
+from .cli_inspect import *
+from .cli_status import *
+
+
+# Initialize plugins that are not enabled by default
+pc.plugins.export_png = pc.PluginExportPngReportlab()
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="PartCAD command line tool",
+    )
+    parser.add_argument(
+        "-v",
+        help="Increase the level of verbosity",
+        dest="verbosity",
+        action="count",
+        default=0,
+    )
+    parser.add_argument(
+        "--no-ansi",
+        help="Plain logging output. Do not use colors or animations.",
+        dest="no_ansi",
+        action="store_true",
+    )
+    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_info(subparsers)
+    cli_help_install(subparsers)
+    cli_help_list(subparsers)
+    cli_help_render(subparsers)
+    cli_help_inspect(subparsers)
+    cli_help_status(subparsers)
+
+    args = parser.parse_args()
+
+    # Configure logging
+    if not args.no_ansi:
+        pc.logging_ansi_terminal_init()
+    else:
+        logging.basicConfig()
+
+    if args.verbosity > 0:
+        pc.logging.setLevel(logging.DEBUG)
+    else:
+        pc.logging.setLevel(logging.INFO)
+
+    try:
+        # First, handle the commands that don't require a context or initialize it
+        # in their own way
+        if args.command == "init":
+            cli_init(args)
+            return
+        elif args.command == "status":
+            cli_status(args)
+            return
+
+        if args.command == "install" or args.command == "update":
+            user_config.force_update = True
+
+        # Initialize the context
+        if not args.config_path is None:
+            ctx = pc.init(args.config_path)
+        else:
+            ctx = pc.init()
+
+        # Handle the command
+        if args.command == "add":
+            with pc_logging.Process("Add", "this"):
+                cli_add(args, ctx)
+
+        elif args.command == "add-part":
+            with pc_logging.Process("AddPart", "this"):
+                cli_add_part(args, ctx)
+
+        elif args.command == "add-assembly":
+            with pc_logging.Process("AddAssy", "this"):
+                cli_add_assembly(args, ctx)
+
+        elif args.command == "info":
+            with pc_logging.Process("Info", "this"):
+                cli_info(args, ctx)
+
+        elif args.command == "install" or args.command == "update":
+            with pc_logging.Process("Install", "this"):
+                cli_install(args, ctx)
+
+        elif args.command == "list":
+            with pc_logging.Process("List", "this"):
+                cli_list(args, ctx)
+
+        elif args.command == "list-all":
+            with pc_logging.Process("ListAll", "this"):
+                cli_list_assemblies(args, ctx)
+                cli_list_parts(args, ctx)
+
+        elif args.command == "list-parts":
+            with pc_logging.Process("ListParts", "this"):
+                cli_list_parts(args, ctx)
+
+        elif args.command == "list-assemblies":
+            with pc_logging.Process("ListAssy", "this"):
+                cli_list_assemblies(args, ctx)
+
+        elif args.command == "render":
+            with pc_logging.Process("Render", "this"):
+                cli_render(args, ctx)
+
+        elif args.command == "inspect":
+            with pc_logging.Process("inspect", "this"):
+                cli_inspect(args, ctx)
+
+        else:
+            print("Unknown command.\n")
+            parser.print_help()
+    except:
+        pc.logging.exception("PartCAD CLI exception")
+
+
+if __name__ == "__main__":
+    main()

{partcad-cli-0.4.2 → partcad-cli-0.5.1}/src/partcad_cli/cli_add.py

@@ -37,7 +37,7 @@ def cli_help_add(subparsers):
         "kind",
         help="Type of the part",
         type=str,
-        choices=["cadquery", "build123d", "step", "stl", "3mf"],
+        choices=["cadquery", "build123d", "scad", "step", "stl", "3mf"],
     )
     parser_add_part.add_argument(
         "path",
@@ -63,17 +63,17 @@ def cli_help_add(subparsers):
 
 
 def cli_add(args, ctx):
-    prj = ctx.get_project(pc.THIS)
+    prj = ctx.get_project(pc.ROOT)
     prj.add_import(args.alias, args.location)
 
 
 def cli_add_part(args, ctx):
-    prj = ctx.get_project(pc.THIS)
+    prj = ctx.get_project(pc.ROOT)
     if prj.add_part(args.kind, args.path):
         Path(args.path).touch()
 
 
 def cli_add_assembly(args, ctx):
-    prj = ctx.get_project(pc.THIS)
+    prj = ctx.get_project(pc.ROOT)
     if prj.add_assembly(args.kind, args.path):
         Path(args.path).touch()

{partcad-cli-0.4.2 → partcad-cli-0.5.1}/src/partcad_cli/cli_info.py

@@ -19,6 +19,16 @@ def cli_help_info(subparsers):
         "info",
         help="Show detailed info a part, assembly or scene",
     )
+
+    parser_info.add_argument(
+        "-P",
+        "--package",
+        help="Package to retrieve the object from",
+        type=str,
+        dest="package",
+        default=None,
+    )
+
     group_type = parser_info.add_mutually_exclusive_group(required=False)
     group_type.add_argument(
         "-a",
@@ -33,6 +43,12 @@ def cli_help_info(subparsers):
         action="store_true",
     )
 
+    parser_info.add_argument(
+        "object",
+        help="Part (default), assembly or scene to show",
+        type=str,
+    )
+
     parser_info.add_argument(
         "-p",
         "--param",
@@ -42,47 +58,41 @@ def cli_help_info(subparsers):
         action="append",
     )
 
-    parser_info.add_argument(
-        "object",
-        help="Part (default), assembly or scene to show",
-        type=str,
-    )
-    parser_info.add_argument(
-        "package",
-        help="Package to retrieve the object from",
-        type=str,
-        nargs="?",
-    )
-
 
 def cli_info(args, ctx):
-    if args.package is None:
-        package = "this"
-    else:
-        package = args.package
-
     params = {}
     if not args.params is None:
         for kv in args.params:
             k, v = kv.split("=")
             params[k] = v
 
+    if args.package is None:
+        if ":" in args.object:
+            path = args.object
+        else:
+            path = ":" + args.object
+    else:
+        path = args.package + ":" + args.object
+
     if args.assembly:
-        obj = ctx.get_assembly(args.object, package, params=params)
+        obj = ctx.get_assembly(path, params=params)
     else:
-        obj = ctx.get_part(args.object, package, params=params)
+        obj = ctx.get_part(path, params=params)
 
     if obj is None:
         if args.package is None:
             pc_logging.error("Object %s not found" % args.object)
         else:
             pc_logging.error(
-                "Object %s not found in package %s" % (args.object, args.package)
+                "Object %s not found in package %s"
+                % (args.object, args.package)
             )
     else:
         pc_logging.info("CONFIGURATION: %s" % pformat(obj.config))
-        asyncio.run(obj.get_shape())
+        asyncio.run(obj.get_wrapped())
         pc_logging.info(
             "RUNTIME PROPERTIES: %s"
-            % pformat({"Memory": "%.02f KB" % ((total_size(obj) + 1023) / 1024)})
+            % pformat(
+                {"Memory": "%.02f KB" % ((total_size(obj) + 1023) / 1024)}
+            )
         )

partcad-cli-0.4.2/src/partcad_cli/cli_show.py → partcad-cli-0.5.1/src/partcad_cli/cli_inspect.py

@@ -11,13 +11,23 @@ import partcad.logging as pc_logging
 
 
 # TODO(clairbee): fix type checking here
-# def cli_help_show(subparsers: argparse._SubParsersAction[argparse.ArgumentParser]):
-def cli_help_show(subparsers):
-    parser_show = subparsers.add_parser(
-        "show",
+# def cli_help_inspect(subparsers: argparse._SubParsersAction[argparse.ArgumentParser]):
+def cli_help_inspect(subparsers):
+    parser_inspect = subparsers.add_parser(
+        "inspect",
         help="Visualize a part, assembly or scene",
     )
-    group_type = parser_show.add_mutually_exclusive_group(required=False)
+
+    parser_inspect.add_argument(
+        "-P",
+        "--package",
+        help="Package to retrieve the object from",
+        type=str,
+        dest="package",
+        default=None,
+    )
+
+    group_type = parser_inspect.add_mutually_exclusive_group(required=False)
     group_type.add_argument(
         "-a",
         help="The object is an assembly",
@@ -31,7 +41,13 @@ def cli_help_show(subparsers):
         action="store_true",
     )
 
-    parser_show.add_argument(
+    parser_inspect.add_argument(
+        "object",
+        help="Path to the part (default), assembly or scene to inspect",
+        type=str,
+    )
+
+    parser_inspect.add_argument(
         "-p",
         "--param",
         metavar="<param_name>=<param_value>",
@@ -40,42 +56,34 @@ def cli_help_show(subparsers):
         action="append",
     )
 
-    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, ctx):
-    if args.package is None:
-        package = "this"
-    else:
-        package = args.package
 
+def cli_inspect(args, ctx):
     params = {}
     if not args.params is None:
         for kv in args.params:
             k, v = kv.split("=")
             params[k] = v
 
+    if args.package is None:
+        if ":" in args.object:
+            path = args.object
+        else:
+            path = ":" + args.object
+    else:
+        path = args.package + ":" + args.object
+
     if args.assembly:
-        obj = ctx.get_assembly(args.object, package, params=params)
+        obj = ctx.get_assembly(path, params=params)
     else:
-        obj = ctx.get_part(args.object, package, params=params)
+        obj = ctx.get_part(path, params=params)
 
     if obj is None:
         if args.package is None:
             pc_logging.error("Object %s not found" % args.object)
         else:
             pc_logging.error(
-                "Object %s not found in package %s" % (args.object, args.package)
+                "Object %s not found in package %s"
+                % (args.object, args.package)
             )
     else:
         obj.show()

{partcad-cli-0.4.2 → partcad-cli-0.5.1}/src/partcad_cli/cli_install.py

@@ -13,6 +13,10 @@ def cli_help_install(subparsers):
         "install",
         help="Download and prepare all imported packages",
     )
+    parser_update = subparsers.add_parser(
+        "update",
+        help="Update all imported packages",
+    )
 
 
 def cli_install(args, ctx):