| Name | ProjectManagerSdk JSON |
| Version |
120.0.4689
JSON |
| download |
| home_page | None |
| Summary | Software development kit for the ProjectManager.com API for Python |
| upload_time | 2024-10-20 22:40:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ProjectManager.com SDK API v4
This software development kit contains all API definitions for the [ProjectManager.com](https://www.projectmanager.com) REST API v4 for Python.
# Why use the SDK?
The ProjectManager API v4 is available as a REST definition in OpenAPI format. You can read the documentation online at [developer.projectmanager.com](https://developer.projectmanager.com).
# Using this SDK
Here's how to add this SDK to create a project.
```powershell
pip install ProjectManagerSdk
```
To create an API client for ProjectManager, you must specify:
* Your API key, and
* Your environment URL.
For the ProjectManager production environment, the environment URL is `https://api.projectmanager.com`.
To [obtain a ProjectManager.com API key](https://softwaredeveloper.projectmanager.com/v4/reference/api-keys):
* Log on to ProjectManager.com
* Click your name in the bottom left hand corner
* Select Account, then API
* Follow the instructions on the page to create a new API key
This example code demonstrates how to retrieve your API key from an environment variable and use it in Python:
```python
import ProjectManagerSdk
import os
# Retrieve API key and create a client
apiKey = os.environ.get('PM_API_KEY')
client = ProjectManagerSdk.ProjectManagerClient('production', 'EXAMPLE_JUPYTER_NOTEBOOK')
client.with_api_key(apiKey)
# Test connectivity to the server
status_results = client.me.retrieve_me()
if not status_results.success or not status_results.data:
print("Your API key is not valid.")
print("Please set the environment variable PM_API_KEY and PM_ENV and try again.")
exit()
print(f"Logged in as {status_results.data.fullName} ({status_results.data.emailAddress})")
```
Raw data
{
"_id": null,
"home_page": null,
"name": "ProjectManagerSdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "\"ProjectManager.com\" <support@projectmanager.com>",
"download_url": "https://files.pythonhosted.org/packages/1a/a1/b05361ca0b18ca9f519659ffa8bdb5d10abded90ec4b4658ff3873817b2f/projectmanagersdk-120.0.4689.tar.gz",
"platform": null,
"description": "\n\n# ProjectManager.com SDK API v4\n\nThis software development kit contains all API definitions for the [ProjectManager.com](https://www.projectmanager.com) REST API v4 for Python.\n\n# Why use the SDK?\n\nThe ProjectManager API v4 is available as a REST definition in OpenAPI format. You can read the documentation online at [developer.projectmanager.com](https://developer.projectmanager.com).\n\n# Using this SDK\n\nHere's how to add this SDK to create a project.\n\n```powershell\npip install ProjectManagerSdk\n```\n\nTo create an API client for ProjectManager, you must specify:\n* Your API key, and\n* Your environment URL.\n\nFor the ProjectManager production environment, the environment URL is `https://api.projectmanager.com`.\n\nTo [obtain a ProjectManager.com API key](https://softwaredeveloper.projectmanager.com/v4/reference/api-keys):\n* Log on to ProjectManager.com\n* Click your name in the bottom left hand corner\n* Select Account, then API\n* Follow the instructions on the page to create a new API key\n\nThis example code demonstrates how to retrieve your API key from an environment variable and use it in Python:\n\n```python\nimport ProjectManagerSdk\nimport os\n\n# Retrieve API key and create a client\napiKey = os.environ.get('PM_API_KEY')\nclient = ProjectManagerSdk.ProjectManagerClient('production', 'EXAMPLE_JUPYTER_NOTEBOOK')\nclient.with_api_key(apiKey)\n\n# Test connectivity to the server\nstatus_results = client.me.retrieve_me()\nif not status_results.success or not status_results.data:\n print(\"Your API key is not valid.\")\n print(\"Please set the environment variable PM_API_KEY and PM_ENV and try again.\")\n exit()\nprint(f\"Logged in as {status_results.data.fullName} ({status_results.data.emailAddress})\")\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Software development kit for the ProjectManager.com API for Python",
"version": "120.0.4689",
"project_urls": {
"Bug Tracker": "https://github.com/projectmgr/projectmanager-sdk-python/issues",
"Homepage": "https://github.com/projectmgr/projectmanager-sdk-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3de800207870e00b3e1632f98b4639509de6300e718d07cfa364e3927d25db5c",
"md5": "908e8b23b4f88670980056ad558ba468",
"sha256": "e855701dd031d59c71b2c06320274e4b843ef208669440c66c6cebbeabd75b99"
},
"downloads": -1,
"filename": "ProjectManagerSdk-120.0.4689-py3-none-any.whl",
"has_sig": false,
"md5_digest": "908e8b23b4f88670980056ad558ba468",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 164614,
"upload_time": "2024-10-20T22:40:11",
"upload_time_iso_8601": "2024-10-20T22:40:11.469131Z",
"url": "https://files.pythonhosted.org/packages/3d/e8/00207870e00b3e1632f98b4639509de6300e718d07cfa364e3927d25db5c/ProjectManagerSdk-120.0.4689-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1aa1b05361ca0b18ca9f519659ffa8bdb5d10abded90ec4b4658ff3873817b2f",
"md5": "96bf7e5496d8476d67ca87ae42232bb2",
"sha256": "6a69ef4a5a053701d58341b0e156e8b5ff742a60047501f0e3f1921a1b70512e"
},
"downloads": -1,
"filename": "projectmanagersdk-120.0.4689.tar.gz",
"has_sig": false,
"md5_digest": "96bf7e5496d8476d67ca87ae42232bb2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 60524,
"upload_time": "2024-10-20T22:40:13",
"upload_time_iso_8601": "2024-10-20T22:40:13.278245Z",
"url": "https://files.pythonhosted.org/packages/1a/a1/b05361ca0b18ca9f519659ffa8bdb5d10abded90ec4b4658ff3873817b2f/projectmanagersdk-120.0.4689.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 22:40:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "projectmgr",
"github_project": "projectmanager-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "projectmanagersdk"
}
