# WrikePy
WrikePy is a Python Wrapper for the [Wrike.com](https://www.wrike.com/) API.
## Getting Started
### Import WrikePy
```python
from wrikepy import *
```
### Initialize API
Every Wrike API call requires a Wrike object parameter in order to send a request.
```python
wrike = Wrike(base_url, perm_access_token, ssl_verify)
```
- The **base_url** parameter is the base URL for every Wrike API
request. The default value is "https://www.wrike.com/api/v4".
- The **perm_access_token** parameter is the API key that you generate from your Wrike account (Apps & Integrations > API). The default value is "None".
- The **ssl_verify** parameter is a security feature that comes
with secure urls. The default value is "True".
### Wrike API
The format of WrikePy mirrors that of the [Wrike API](https://developers.wrike.com/) documentation methods. WrikePy includes a class for each API method and a function for each API call type. As an example, the following will get a folders and/or projects from within a folder...
```python
folders = FoldersProjects(wrike, ["folderId"], {"paramKey": "paramValue"}).query__folders_folderId_folders()
```
### Function Naming Conventions
Functions following the naming conventions put forth in the API documentation.
| Name | Request Type |
|--|--|
| query__ | GET |
| create__ | POST |
| update__ | PUT |
| delete__ | DELETE |
| create_files__ | POST (Upload Files) |
| update_files__ | PUT (Update Files) |
Raw data
{
"_id": null,
"home_page": "https://github.com/TGoers-FNSB/WrikePy",
"name": "WrikePy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "T. Goers",
"author_email": "tristan.goers@fnsb.gov",
"download_url": "https://files.pythonhosted.org/packages/82/95/ddb3ba41de2fbfcff22b68b8e75d332babba7a86f249e5c16ee2c3e21ba5/WrikePy-1.0.1.tar.gz",
"platform": null,
"description": "# WrikePy\r\nWrikePy is a Python Wrapper for the [Wrike.com](https://www.wrike.com/) API.\r\n\r\n## Getting Started\r\n### Import WrikePy\r\n```python\r\nfrom wrikepy import *\r\n```\r\n### Initialize API\r\nEvery Wrike API call requires a Wrike object parameter in order to send a request.\r\n```python\r\nwrike = Wrike(base_url, perm_access_token, ssl_verify)\r\n```\r\n - The **base_url** parameter is the base URL for every Wrike API\r\n request. The default value is \"https://www.wrike.com/api/v4\". \r\n - The **perm_access_token** parameter is the API key that you generate from your Wrike account (Apps & Integrations > API). The default value is \"None\".\r\n - The **ssl_verify** parameter is a security feature that comes\r\n with secure urls. The default value is \"True\".\r\n### Wrike API\r\nThe format of WrikePy mirrors that of the [Wrike API](https://developers.wrike.com/) documentation methods. WrikePy includes a class for each API method and a function for each API call type. As an example, the following will get a folders and/or projects from within a folder...\r\n```python\r\nfolders = FoldersProjects(wrike, [\"folderId\"], {\"paramKey\": \"paramValue\"}).query__folders_folderId_folders()\r\n```\r\n### Function Naming Conventions\r\nFunctions following the naming conventions put forth in the API documentation.\r\n| Name | Request Type |\r\n|--|--|\r\n| query__ | GET |\r\n| create__ | POST |\r\n| update__ | PUT |\r\n| delete__ | DELETE |\r\n| create_files__ | POST (Upload Files) |\r\n| update_files__ | PUT (Update Files) |\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python wrapper for the Wrike API.",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/TGoers-FNSB/WrikePy/issues",
"Homepage": "https://github.com/TGoers-FNSB/WrikePy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3c3f682c2bb7338c8dae7e7e54a5cad56791eb50e2f1b06ff3c9d77a4ba4d9e0",
"md5": "7b455acb52252469139537496292b784",
"sha256": "06c62c155c6b2a98156f0e0d41578278ea379f122987aa2ffb29601c046a07d2"
},
"downloads": -1,
"filename": "WrikePy-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7b455acb52252469139537496292b784",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12003,
"upload_time": "2023-06-20T16:28:57",
"upload_time_iso_8601": "2023-06-20T16:28:57.176698Z",
"url": "https://files.pythonhosted.org/packages/3c/3f/682c2bb7338c8dae7e7e54a5cad56791eb50e2f1b06ff3c9d77a4ba4d9e0/WrikePy-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8295ddb3ba41de2fbfcff22b68b8e75d332babba7a86f249e5c16ee2c3e21ba5",
"md5": "b5e862ecd44a386c70595f9f73d26ce3",
"sha256": "7df4fe3fb1567151b9f4668cd457a77cd5261f297f29092ed56d0ae3f8676943"
},
"downloads": -1,
"filename": "WrikePy-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "b5e862ecd44a386c70595f9f73d26ce3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 12374,
"upload_time": "2023-06-20T16:29:01",
"upload_time_iso_8601": "2023-06-20T16:29:01.343463Z",
"url": "https://files.pythonhosted.org/packages/82/95/ddb3ba41de2fbfcff22b68b8e75d332babba7a86f249e5c16ee2c3e21ba5/WrikePy-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-20 16:29:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TGoers-FNSB",
"github_project": "WrikePy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "wrikepy"
}
JSON
