# candor-py
Python Library for Candor Services' Project Mercury API.
## Documentation
`candor.py` requires Python 3.8 or higher.
You can add the library to your project with:
```
pip install candor
```
Your public API key can be found at https://dashboard.candorservices.net/api-dashboard.
### Verifying a license
You can verify if a license is valid using this function:
```py
valid = verifyLicense(PUB_API_KEY, LICENSE_KEY, PRODUCT_ID);
```
You'll want to grab your product ID from https://dashboard.candorservices.net/license-manager by creating a new product and then adding a license. The license key should be added by the client, using some sort of config (we recommend remote configs, see below!). Assign your license to your client using the tools in the dashboard.
### Retrieving a remote config
Remote configs allow clients to easily configure parts of their apps without having to mess with complicated or messy configuration files. You can use this function:
```py
obj = candor.getConfig(PUB_API_KEY, CONFIG_ID);
```
to retrieve the remote config as an object. You can create a remote config at https://dashboard.candorservices.net/config-manager.
## Need support?
If you need help with anything to do with this project, then please see the [project-mercury-support](https://discord.com/channels/650773903236399134/1146431646418079744) channel in Discord under the FREELANCERS category.
Raw data
{
"_id": null,
"home_page": "https://github.com/candorservices/candor-py",
"name": "candor",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "FroostySnoowman",
"author_email": "froostysnoowmanbusiness@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8c/95/212f9f80a5bb9aac814e3b9c5aceff48334dc971ee792e405b3ddda0f8b7/candor-1.0.tar.gz",
"platform": null,
"description": "# candor-py\r\nPython Library for Candor Services' Project Mercury API.\r\n\r\n## Documentation\r\n`candor.py` requires Python 3.8 or higher.\r\nYou can add the library to your project with:\r\n```\r\npip install candor\r\n```\r\n\r\nYour public API key can be found at https://dashboard.candorservices.net/api-dashboard.\r\n\r\n### Verifying a license\r\nYou can verify if a license is valid using this function:\r\n```py\r\nvalid = verifyLicense(PUB_API_KEY, LICENSE_KEY, PRODUCT_ID);\r\n```\r\n\r\nYou'll want to grab your product ID from https://dashboard.candorservices.net/license-manager by creating a new product and then adding a license. The license key should be added by the client, using some sort of config (we recommend remote configs, see below!). Assign your license to your client using the tools in the dashboard.\r\n\r\n### Retrieving a remote config\r\nRemote configs allow clients to easily configure parts of their apps without having to mess with complicated or messy configuration files. You can use this function:\r\n```py\r\nobj = candor.getConfig(PUB_API_KEY, CONFIG_ID);\r\n```\r\nto retrieve the remote config as an object. You can create a remote config at https://dashboard.candorservices.net/config-manager.\r\n\r\n## Need support?\r\nIf you need help with anything to do with this project, then please see the [project-mercury-support](https://discord.com/channels/650773903236399134/1146431646418079744) channel in Discord under the FREELANCERS category.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Python Library for Candor Services' Project Mercury API.",
"version": "1.0",
"project_urls": {
"Homepage": "https://github.com/candorservices/candor-py"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "540e6b52391256d9ffcab927e8b61661f8d7ef0644f5d6edba190b9a03e22ad7",
"md5": "a028e364f7509b1b09c53d478cd69ca3",
"sha256": "f11f8aa4713a95efb6f313c99cac2d5b07642a871469b02f7d3164a91dd722f6"
},
"downloads": -1,
"filename": "candor-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a028e364f7509b1b09c53d478cd69ca3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2716,
"upload_time": "2023-09-20T13:47:26",
"upload_time_iso_8601": "2023-09-20T13:47:26.502178Z",
"url": "https://files.pythonhosted.org/packages/54/0e/6b52391256d9ffcab927e8b61661f8d7ef0644f5d6edba190b9a03e22ad7/candor-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c95212f9f80a5bb9aac814e3b9c5aceff48334dc971ee792e405b3ddda0f8b7",
"md5": "53ab4b077fdc968cfcf366fa1fbd5074",
"sha256": "d2fbf8063ce36e039bd4271f483cecfdbcf486fd5ffc11ba455aaf6fadb1133e"
},
"downloads": -1,
"filename": "candor-1.0.tar.gz",
"has_sig": false,
"md5_digest": "53ab4b077fdc968cfcf366fa1fbd5074",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2533,
"upload_time": "2023-09-20T13:47:28",
"upload_time_iso_8601": "2023-09-20T13:47:28.663611Z",
"url": "https://files.pythonhosted.org/packages/8c/95/212f9f80a5bb9aac814e3b9c5aceff48334dc971ee792e405b3ddda0f8b7/candor-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-20 13:47:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "candorservices",
"github_project": "candor-py",
"github_not_found": true,
"lcname": "candor"
}
JSON
