# wbteampropy
Python interface for the WbTeamPro API
# WbTeamPropy
WbTeamPropy is a Python interface to the WbTeamPro REST API.
## Usage
Create a WbTeamPro interface with the API URL and credentials and use it to
call the API.
```python
import wbteampropy
wbteampro = wbteampropy.WBTEAMPRO(
'https://example.com/modules/addons/wbteampro/api.php',
'username',
'password')
wbteampro.get_project(110)
```
API USERNAME
This is a valid Administrator username that is within a WHMCS Administrative Role that has been granted access to the wbTeamPro system.
API PASSWORD
This is the password for the valid Administrator
In general API methods can be called as methods in the WBTEAMPRO class. For
available API methods see the [WbTeamPro API reference](
https://docs.holodyn.com/WHMCS/wbTeamPro/v3/Web_API).
Note that the casing of the methods differ from the API actions. While the
API actions are CamelCased the methods are snake_cased.
### Calling unimplemented actions
Not all API actions are implemented as Python methods (they will be
implemented as required, of course pull-requests are accepted). In order to
call actions that are not yet implemented call() can be used. Example:
```python
response = wbteampro.call(
'SomeAction',
param=value,
list_param=[
element,
element2,
]
)
```
See the call() documentation for more info.
Raw data
{
"_id": null,
"home_page": "https://github.com/artphi/wbteampropy",
"name": "wbteampropy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "wbteampro api library",
"author": "artphi",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/cf/65/15bae58c85465102a11a1201663943c69ba3b51cefe7c662534d11300990/wbteampropy-0.1.0.tar.gz",
"platform": null,
"description": "# wbteampropy\r\nPython interface for the WbTeamPro API\r\n\r\n\r\n# WbTeamPropy\r\n\r\nWbTeamPropy is a Python interface to the WbTeamPro REST API.\r\n\r\n## Usage\r\n\r\nCreate a WbTeamPro interface with the API URL and credentials and use it to\r\ncall the API.\r\n\r\n```python\r\nimport wbteampropy\r\n\r\nwbteampro = wbteampropy.WBTEAMPRO(\r\n 'https://example.com/modules/addons/wbteampro/api.php',\r\n 'username',\r\n 'password')\r\nwbteampro.get_project(110)\r\n```\r\n\r\nAPI USERNAME \r\nThis is a valid Administrator username that is within a WHMCS Administrative Role that has been granted access to the wbTeamPro system.\r\n\r\nAPI PASSWORD \r\nThis is the password for the valid Administrator\r\n\r\nIn general API methods can be called as methods in the WBTEAMPRO class. For\r\navailable API methods see the [WbTeamPro API reference](\r\nhttps://docs.holodyn.com/WHMCS/wbTeamPro/v3/Web_API).\r\nNote that the casing of the methods differ from the API actions. While the\r\nAPI actions are CamelCased the methods are snake_cased.\r\n\r\n### Calling unimplemented actions\r\n\r\nNot all API actions are implemented as Python methods (they will be\r\nimplemented as required, of course pull-requests are accepted). In order to\r\ncall actions that are not yet implemented call() can be used. Example:\r\n\r\n```python\r\nresponse = wbteampro.call(\r\n 'SomeAction',\r\n param=value,\r\n list_param=[\r\n element,\r\n element2,\r\n ]\r\n)\r\n```\r\n\r\nSee the call() documentation for more info.\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "GPL-3",
"summary": "Python interface to the WBTEAMPRO API.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/artphi/wbteampropy"
},
"split_keywords": [
"wbteampro",
"api",
"library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dbfcebb98b15467617726be7786b6000dbce9230b0e7f75f6bd4c1b30354cce8",
"md5": "9bee76a88931bb8e52f671d3cdd691d9",
"sha256": "09f45d8efc8a0f70d7bde5c096c056218260bfaa2450d9009c6eb3b1b65ebbaa"
},
"downloads": -1,
"filename": "wbteampropy-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9bee76a88931bb8e52f671d3cdd691d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16408,
"upload_time": "2023-05-20T09:18:55",
"upload_time_iso_8601": "2023-05-20T09:18:55.672697Z",
"url": "https://files.pythonhosted.org/packages/db/fc/ebb98b15467617726be7786b6000dbce9230b0e7f75f6bd4c1b30354cce8/wbteampropy-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cf6515bae58c85465102a11a1201663943c69ba3b51cefe7c662534d11300990",
"md5": "f4d447ed79f7d7af047f0c18e22de681",
"sha256": "deb62221952b46f9295869cd7fe043031955bcb9b2a73257f447e3bb855a9d3a"
},
"downloads": -1,
"filename": "wbteampropy-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f4d447ed79f7d7af047f0c18e22de681",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15778,
"upload_time": "2023-05-20T09:18:58",
"upload_time_iso_8601": "2023-05-20T09:18:58.162207Z",
"url": "https://files.pythonhosted.org/packages/cf/65/15bae58c85465102a11a1201663943c69ba3b51cefe7c662534d11300990/wbteampropy-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-20 09:18:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "artphi",
"github_project": "wbteampropy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "wbteampropy"
}
JSON
