batchx

Name	batchx JSON
Version	9.15.1 JSON
	download
home_page	https://github.com/batchx/api
Summary	Batchx Python API
upload_time	2024-09-06 18:24:03
maintainer	None
docs_url	None
author	Batchx
requires_python	None
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            Contents
--------

The ``batchx`` package contains the ``bx`` main application module, that
offers full access to the BatchX gRPC API from Python code.

How to use
----------

.. code:: python

   # Import the module
   from batchx import bx

   # Connect to the BatchX servers 
   # (environment variables `BATCHX_ENDPOINT` and `BATCHX_TOKEN` expected)
   bx.connect()

   # Instantiate service class
   org_service = bx.OrganizationService()

   # Create data request
   request = org_service.GetOrganizationRequest(organization="batchx")

   # Call the RPC
   response = org_service.GetOrganization(request);

   print(response)

See also
--------

-  BatchX documentation: https://docs.batchx.io
-  Python protobuf messages:
   https://developers.google.com/protocol-buffers/docs/reference/python-generated



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/batchx/api",
    "name": "batchx",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Batchx",
    "author_email": "dev@batchx.com",
    "download_url": "https://files.pythonhosted.org/packages/9d/15/2f46f17c80b055ef13adc83085f4c4c7640937a5cb056793c8444fc4d2fc/batchx-9.15.1.tar.gz",
    "platform": null,
    "description": "Contents\n--------\n\nThe ``batchx`` package contains the ``bx`` main application module, that\noffers full access to the BatchX gRPC API from Python code.\n\nHow to use\n----------\n\n.. code:: python\n\n   # Import the module\n   from batchx import bx\n\n   # Connect to the BatchX servers \n   # (environment variables `BATCHX_ENDPOINT` and `BATCHX_TOKEN` expected)\n   bx.connect()\n\n   # Instantiate service class\n   org_service = bx.OrganizationService()\n\n   # Create data request\n   request = org_service.GetOrganizationRequest(organization=\"batchx\")\n\n   # Call the RPC\n   response = org_service.GetOrganization(request);\n\n   print(response)\n\nSee also\n--------\n\n-  BatchX documentation: https://docs.batchx.io\n-  Python protobuf messages:\n   https://developers.google.com/protocol-buffers/docs/reference/python-generated\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Batchx Python API",
    "version": "9.15.1",
    "project_urls": {
        "Homepage": "https://github.com/batchx/api"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9d152f46f17c80b055ef13adc83085f4c4c7640937a5cb056793c8444fc4d2fc",
                "md5": "9ce079d5dc0407680f9b1e91a21335f7",
                "sha256": "adb8227864ff1d687d6f6dbe8d8158f8f4718779a4835786cd92c5c80f65e6fb"
            },
            "downloads": -1,
            "filename": "batchx-9.15.1.tar.gz",
            "has_sig": false,
            "md5_digest": "9ce079d5dc0407680f9b1e91a21335f7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 54833,
            "upload_time": "2024-09-06T18:24:03",
            "upload_time_iso_8601": "2024-09-06T18:24:03.036363Z",
            "url": "https://files.pythonhosted.org/packages/9d/15/2f46f17c80b055ef13adc83085f4c4c7640937a5cb056793c8444fc4d2fc/batchx-9.15.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-06 18:24:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "batchx",
    "github_project": "api",
    "github_not_found": true,
    "lcname": "batchx"
}