kerfed.client


Namekerfed.client JSON
Version 0.2.2 PyPI version JSON
download
home_pageNone
SummaryLibrary for analyzing CAD geometry.
upload_time2025-08-20 20:50:14
maintainerNone
docs_urlNone
authorKerfed, Inc.
requires_python>=3.7
licenseThe MIT License (MIT) Copyright (c) 2024 Kerfed, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords manufacturing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # kerfed.client

A client for the Kerfed Engine which reliably analyzes 2D or 3D CAD geometry into a well-defined data structure. It can be used for many applications, including e-commerce, robotic automation, and process analysis.

Check out an API demo which converts a mesh into a full milling plan with G-code at [CarveWizard](https://carvewizard.com).

### Install

```
pip install kerfed.client
```

### Quick Start

```python
import os
import kerfed.client as ke

if __name__ == "__main__":

   # create a client using a free tier API key
   # requests may be rate limited, de-scoped, and run on slower hardware 
    client = ke.EngineClient(api_key="kerfed_limited_access")


    # Generate a GeometryRequest
    file_name = "tray.stl.zip"
    with open(file_name, "rb") as f:
        request = ke.GeometryRequest(
            source=ke.FileBlob(
                name=file_name,
                data=f.read(),
            ),
            source_units="inches",
        )

    # Start the geometry request running in the cloud.
    task_id = client.geometry_start(request, upload=True)

    # This will either return a `GeometryReponse` or raise an error.
    response = client.geometry_result(task_id=task_id)
```

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "kerfed.client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "manufacturing",
    "author": "Kerfed, Inc.",
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "# kerfed.client\n\nA client for the Kerfed Engine which reliably analyzes 2D or 3D CAD geometry into a well-defined data structure. It can be used for many applications, including e-commerce, robotic automation, and process analysis.\n\nCheck out an API demo which converts a mesh into a full milling plan with G-code at [CarveWizard](https://carvewizard.com).\n\n### Install\n\n```\npip install kerfed.client\n```\n\n### Quick Start\n\n```python\nimport os\nimport kerfed.client as ke\n\nif __name__ == \"__main__\":\n\n   # create a client using a free tier API key\n   # requests may be rate limited, de-scoped, and run on slower hardware \n    client = ke.EngineClient(api_key=\"kerfed_limited_access\")\n\n\n    # Generate a GeometryRequest\n    file_name = \"tray.stl.zip\"\n    with open(file_name, \"rb\") as f:\n        request = ke.GeometryRequest(\n            source=ke.FileBlob(\n                name=file_name,\n                data=f.read(),\n            ),\n            source_units=\"inches\",\n        )\n\n    # Start the geometry request running in the cloud.\n    task_id = client.geometry_start(request, upload=True)\n\n    # This will either return a `GeometryReponse` or raise an error.\n    response = client.geometry_result(task_id=task_id)\n```\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT)\n        \n        Copyright (c) 2024 Kerfed, Inc.\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "Library for analyzing CAD geometry.",
    "version": "0.2.2",
    "project_urls": {
        "Homepage": "https://github.com/kerfed/client"
    },
    "split_keywords": [
        "manufacturing"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "07a780338a56a47ddd93640e7eaea88b35aacb8b111df8632a44f76380390f9f",
                "md5": "38f23cf3e56db4d54a839f2e8a3120a3",
                "sha256": "9e3edf0f0b6506a5c841e51cbb0eb7f78cd855ddb949e6bea6f5cf8abef49f12"
            },
            "downloads": -1,
            "filename": "kerfed_client-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "38f23cf3e56db4d54a839f2e8a3120a3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 11988,
            "upload_time": "2025-08-20T20:50:14",
            "upload_time_iso_8601": "2025-08-20T20:50:14.094826Z",
            "url": "https://files.pythonhosted.org/packages/07/a7/80338a56a47ddd93640e7eaea88b35aacb8b111df8632a44f76380390f9f/kerfed_client-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-20 20:50:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kerfed",
    "github_project": "client",
    "github_not_found": true,
    "lcname": "kerfed.client"
}
Kerfed, Inc.
Elapsed time: 3.93448s