vqueue-sdk


Namevqueue-sdk JSON
Version 0.1.1 PyPI version JSON
download
home_pageNone
SummaryA toolset for Virtual Queue integrations in Python
upload_time2025-07-16 18:35:05
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords tickets queue async events high-demand
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Virtual Queue Python SDK

SDK to communicate with Virtual Queue's API in Python projects.

## How to use

> [!NOTE]
> See [`examples/`](./examples/) for more

You can verify the token with `TokenVerifier` like this:

```python
from vqueue import TokenVerifier
from vqueue.exceptions import VQueueApiError, VQueueError, VQueueNetworkError


def your_function_or_handler():
    # Get the token from the request in your system
    token = str(uuid4())  # This is an example UUIDv4

    # This handles the connections with a session and can be reused
    # for better performance
    verifier = TokenVerifier()

    try:
        # Handle the happy path
        verified_result = verifier.verify_token(token)
        print("The token was successfuly verified:", verified_result)
    except ValueError as ve:
        # Then handle the possible errors
        # Of course, you should handle the exceptions with more grace than this
        print("The token is not valir UUID", ve)
    except VQueueNetworkError as ne:
        print("Network error", ne)
    except VQueueApiError as ae:
        print("The API returned an error status", ae)
    except VQueueError as vqe:
        print("A generic error with the Virtual Queue system or this SDK", vqe)
```

You can also wrap your code in a context managed `with` block:

```python
    with TokenVerifier() as verfifier:
        try:
            # Handle the happy path
            verified_result = verifier.verify_token(token)
            print("The token was successfuly verified:", verified_result)
        except ValueError as ve:
            # Then handle the possible errors
            # Of course, you should handle the exceptions with more grace than this
            print("The token is not valir UUID", ve)
        except VQueueNetworkError as ne:
            print("Network error", ne)
        except VQueueApiError as ae:
            print("The API returned an error status", ae)
        except VQueueError as vqe:
            print("A generic error with the Virtual Queue system or this SDK", vqe)
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "vqueue-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "tickets, queue, async, events, high-demand",
    "author": null,
    "author_email": "\"Animus Coop.\" <info@animus.com.ar>",
    "download_url": "https://files.pythonhosted.org/packages/06/a2/a132ef2f4d0900488d2ff15b278caa0fdcfc014079248091c033b494e1f1/vqueue_sdk-0.1.1.tar.gz",
    "platform": null,
    "description": "# Virtual Queue Python SDK\n\nSDK to communicate with Virtual Queue's API in Python projects.\n\n## How to use\n\n> [!NOTE]\n> See [`examples/`](./examples/) for more\n\nYou can verify the token with `TokenVerifier` like this:\n\n```python\nfrom vqueue import TokenVerifier\nfrom vqueue.exceptions import VQueueApiError, VQueueError, VQueueNetworkError\n\n\ndef your_function_or_handler():\n    # Get the token from the request in your system\n    token = str(uuid4())  # This is an example UUIDv4\n\n    # This handles the connections with a session and can be reused\n    # for better performance\n    verifier = TokenVerifier()\n\n    try:\n        # Handle the happy path\n        verified_result = verifier.verify_token(token)\n        print(\"The token was successfuly verified:\", verified_result)\n    except ValueError as ve:\n        # Then handle the possible errors\n        # Of course, you should handle the exceptions with more grace than this\n        print(\"The token is not valir UUID\", ve)\n    except VQueueNetworkError as ne:\n        print(\"Network error\", ne)\n    except VQueueApiError as ae:\n        print(\"The API returned an error status\", ae)\n    except VQueueError as vqe:\n        print(\"A generic error with the Virtual Queue system or this SDK\", vqe)\n```\n\nYou can also wrap your code in a context managed `with` block:\n\n```python\n    with TokenVerifier() as verfifier:\n        try:\n            # Handle the happy path\n            verified_result = verifier.verify_token(token)\n            print(\"The token was successfuly verified:\", verified_result)\n        except ValueError as ve:\n            # Then handle the possible errors\n            # Of course, you should handle the exceptions with more grace than this\n            print(\"The token is not valir UUID\", ve)\n        except VQueueNetworkError as ne:\n            print(\"Network error\", ne)\n        except VQueueApiError as ae:\n            print(\"The API returned an error status\", ae)\n        except VQueueError as vqe:\n            print(\"A generic error with the Virtual Queue system or this SDK\", vqe)\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A toolset for Virtual Queue integrations in Python",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/animus-coop/virtual-queue-python-sdk"
    },
    "split_keywords": [
        "tickets",
        " queue",
        " async",
        " events",
        " high-demand"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8ac57064d6685107ae8205a12a7255b958ca748a62e2d2ab5ff76abf82187813",
                "md5": "c02941f8720b616be28fb13af177e9b4",
                "sha256": "894e7135271c84a58e445edbaeb750520d93d86a00f8c0c455d1899652b30ca4"
            },
            "downloads": -1,
            "filename": "vqueue_sdk-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c02941f8720b616be28fb13af177e9b4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 4944,
            "upload_time": "2025-07-16T18:35:04",
            "upload_time_iso_8601": "2025-07-16T18:35:04.590062Z",
            "url": "https://files.pythonhosted.org/packages/8a/c5/7064d6685107ae8205a12a7255b958ca748a62e2d2ab5ff76abf82187813/vqueue_sdk-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "06a2a132ef2f4d0900488d2ff15b278caa0fdcfc014079248091c033b494e1f1",
                "md5": "51079dcc3375657e4bd2c2c59b247f56",
                "sha256": "3fe148896b237ae4476e969d43a1968bb453721bc1ca89ed51c72095bc89517b"
            },
            "downloads": -1,
            "filename": "vqueue_sdk-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "51079dcc3375657e4bd2c2c59b247f56",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 5132,
            "upload_time": "2025-07-16T18:35:05",
            "upload_time_iso_8601": "2025-07-16T18:35:05.341382Z",
            "url": "https://files.pythonhosted.org/packages/06/a2/a132ef2f4d0900488d2ff15b278caa0fdcfc014079248091c033b494e1f1/vqueue_sdk-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-16 18:35:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "animus-coop",
    "github_project": "virtual-queue-python-sdk",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "vqueue-sdk"
}
        
Elapsed time: 1.38407s