autocortext-py


Nameautocortext-py JSON
Version 0.4.1 PyPI version JSON
download
home_pagehttps://autocortext.com
SummarySimple client for AutoCortext API
upload_time2024-05-13 22:35:09
maintainerNone
docs_urlNone
authorMark Watson
requires_python>=3.0
licenseNone
keywords autocortext
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## Simple AutoCortext API Client

This is a simple client for the AutoCortext API.

### Setup

1. An `.env` file with the variable `AUTOCORTEXT_API_KEY` set to a valid key.
1. An `.env` file with the variable `AUTOCORTEXT_ORG_ID` set to a valid organization ID.

### Example

Install the AutoCortext clinet using `pip`.

```shell
pip install autocortext-py
```

Use the client in your source code.

```python
import os
from autocortext_py import AutoCortext
from dotenv import load_dotenv

load_dotenv()

client = AutoCortext(
    org_id=os.getenv("AUTOCORTEXT_ORG_ID"),
    api_key=os.getenv("AUTOCORTEXT_API_KEY"),
)

client.config(
    verbosity="concise",
    machine="Conveyor System",
    system="Electrical",
    response_type="Technician",
    env="prod",
)

res = client.troubleshoot("The 24 volt system in the conveyor is not powering on.")
print(res)

client.set_verbosity("verbose")
res = client.troubleshoot("OK how do I fix it?")
print(res)

client.save()
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://autocortext.com",
    "name": "autocortext-py",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.0",
    "maintainer_email": null,
    "keywords": "autocortext",
    "author": "Mark Watson",
    "author_email": "markus.c.watson@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/af/c1/852e2a1e9da52f4445cf7e8d82b02e38ed569ac512007405b8e273c7b431/autocortext_py-0.4.1.tar.gz",
    "platform": null,
    "description": "## Simple AutoCortext API Client\n\nThis is a simple client for the AutoCortext API.\n\n### Setup\n\n1. An `.env` file with the variable `AUTOCORTEXT_API_KEY` set to a valid key.\n1. An `.env` file with the variable `AUTOCORTEXT_ORG_ID` set to a valid organization ID.\n\n### Example\n\nInstall the AutoCortext clinet using `pip`.\n\n```shell\npip install autocortext-py\n```\n\nUse the client in your source code.\n\n```python\nimport os\nfrom autocortext_py import AutoCortext\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nclient = AutoCortext(\n    org_id=os.getenv(\"AUTOCORTEXT_ORG_ID\"),\n    api_key=os.getenv(\"AUTOCORTEXT_API_KEY\"),\n)\n\nclient.config(\n    verbosity=\"concise\",\n    machine=\"Conveyor System\",\n    system=\"Electrical\",\n    response_type=\"Technician\",\n    env=\"prod\",\n)\n\nres = client.troubleshoot(\"The 24 volt system in the conveyor is not powering on.\")\nprint(res)\n\nclient.set_verbosity(\"verbose\")\nres = client.troubleshoot(\"OK how do I fix it?\")\nprint(res)\n\nclient.save()\n```\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Simple client for AutoCortext API",
    "version": "0.4.1",
    "project_urls": {
        "Homepage": "https://autocortext.com"
    },
    "split_keywords": [
        "autocortext"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2fb3a5c61d50264f230b943b097320842a0e4ed6796bd712f45ca27394841882",
                "md5": "680fdb59ff0c58cb2131f5c2c4d9ff9e",
                "sha256": "dea8b0b632d01cdd3c924ba38907432c3f5d026f8a6c4c43a11019a08e610031"
            },
            "downloads": -1,
            "filename": "autocortext_py-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "680fdb59ff0c58cb2131f5c2c4d9ff9e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.0",
            "size": 5710,
            "upload_time": "2024-05-13T22:35:07",
            "upload_time_iso_8601": "2024-05-13T22:35:07.884987Z",
            "url": "https://files.pythonhosted.org/packages/2f/b3/a5c61d50264f230b943b097320842a0e4ed6796bd712f45ca27394841882/autocortext_py-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "afc1852e2a1e9da52f4445cf7e8d82b02e38ed569ac512007405b8e273c7b431",
                "md5": "eb502dc51351636fa0ba26744f3071bb",
                "sha256": "42b09d16c759877561959f5c05972602315b9acae31558bf7c85c70214e1dfb3"
            },
            "downloads": -1,
            "filename": "autocortext_py-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "eb502dc51351636fa0ba26744f3071bb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.0",
            "size": 5222,
            "upload_time": "2024-05-13T22:35:09",
            "upload_time_iso_8601": "2024-05-13T22:35:09.004293Z",
            "url": "https://files.pythonhosted.org/packages/af/c1/852e2a1e9da52f4445cf7e8d82b02e38ed569ac512007405b8e273c7b431/autocortext_py-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-13 22:35:09",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "autocortext-py"
}
        
Elapsed time: 0.24935s