virtualcollegeapiwrapper

Name	virtualcollegeapiwrapper JSON
Version	0.1.6 JSON
	download
home_page
Summary
upload_time	2023-12-06 14:57:18
maintainer
docs_url	None
author	Your Name
requires_python	>=3.12,<4.0
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # VirtualCollegeAPI

original API DOCS  https://enableapi.docs.apiary.io/#reference/security/access-tokens

This is a small project, the entire API is not covered yet, 
I just added the methods that I needed, PRs are welcome.

it handles the creation of JWT and the encoding


## Install
`pip install virtualcollegeapiwrapper`

## Usage example
```
from VirtualCollegeAPIWrapper.VirtualCollege import VirtualCollegeAPI

# InstanceReference and PublicKeyAPI can be found in Virtual college -> Settings -> Api Settings
# You will need an admin account

VC = VirtualCollegeAPI(InstanceReference, PublicKeyAPI, "https://external-api.vc-enable.co.uk")
print(VC.count_users())
```

For the list of methods look at the Class VirtualCollegeAPI code.
            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "virtualcollegeapiwrapper",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.12,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/bc/55/f6211e3085c4ed3be532d3301ba2163d299ebf256b3ad4d3c9c7dc3cddca/virtualcollegeapiwrapper-0.1.6.tar.gz",
    "platform": null,
    "description": "# VirtualCollegeAPI\n\noriginal API DOCS  https://enableapi.docs.apiary.io/#reference/security/access-tokens\n\nThis is a small project, the entire API is not covered yet, \nI just added the methods that I needed, PRs are welcome.\n\nit handles the creation of JWT and the encoding\n\n\n## Install\n`pip install virtualcollegeapiwrapper`\n\n## Usage example\n```\nfrom VirtualCollegeAPIWrapper.VirtualCollege import VirtualCollegeAPI\n\n# InstanceReference and PublicKeyAPI can be found in Virtual college -> Settings -> Api Settings\n# You will need an admin account\n\nVC = VirtualCollegeAPI(InstanceReference, PublicKeyAPI, \"https://external-api.vc-enable.co.uk\")\nprint(VC.count_users())\n```\n\nFor the list of methods look at the Class VirtualCollegeAPI code.",
    "bugtrack_url": null,
    "license": "",
    "summary": "",
    "version": "0.1.6",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0927dd1aae7311d1f8dff120068455ca97e6ee871b95159f30affbecd24e65d0",
                "md5": "ac3ed6e505f3d4e4a20412da2942c1af",
                "sha256": "2612dd00ebee4f188807f046a856a8a9d16b03576d7214547773a770d33ccb45"
            },
            "downloads": -1,
            "filename": "virtualcollegeapiwrapper-0.1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ac3ed6e505f3d4e4a20412da2942c1af",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12,<4.0",
            "size": 4370,
            "upload_time": "2023-12-06T14:57:17",
            "upload_time_iso_8601": "2023-12-06T14:57:17.067805Z",
            "url": "https://files.pythonhosted.org/packages/09/27/dd1aae7311d1f8dff120068455ca97e6ee871b95159f30affbecd24e65d0/virtualcollegeapiwrapper-0.1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bc55f6211e3085c4ed3be532d3301ba2163d299ebf256b3ad4d3c9c7dc3cddca",
                "md5": "54868c9f1069a608f552b002d8b979de",
                "sha256": "606315871b7df064f3922e96aecd138b235b051a77a0c0982d7d1c3e364b0311"
            },
            "downloads": -1,
            "filename": "virtualcollegeapiwrapper-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "54868c9f1069a608f552b002d8b979de",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12,<4.0",
            "size": 3732,
            "upload_time": "2023-12-06T14:57:18",
            "upload_time_iso_8601": "2023-12-06T14:57:18.690830Z",
            "url": "https://files.pythonhosted.org/packages/bc/55/f6211e3085c4ed3be532d3301ba2163d299ebf256b3ad4d3c9c7dc3cddca/virtualcollegeapiwrapper-0.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-06 14:57:18",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "virtualcollegeapiwrapper"
}