# A Python Class for Akamai Property
An Object oriented implementation of Akamai Property.
The advantage of Akamai Property class is application developers need not know about the PAPI calls and their usage. Application developers can just focus on getting their work done on Property Manager configs programmatically using the objects of AkamaiProperty.
### Credentials
In order to use this configuration, you need to:
* Set up your credential files as described in the [authorization](https://developer.akamai.com/introduction/Prov_Creds.html) and [credentials](https://developer.akamai.com/introduction/Conf_Client.html) sections of the getting started guide on developer.akamai.com.
* When working through this process you need to give grants for the property manager API and the User Admin API (if you will want to move properties). The section in your configuration file should be called 'papi'.
## Overview
The advantage of Akamai Property class is application developers need not know about the PAPI calls and their usage. Application developers can just focus on getting their work done on Property Manager configs programmatically using the objects of AkamaiProperty.
## Install Dependencies If you are using source code.
```
$ pip install -r requirements.txt
```
### Install pip package available
```
$ pip install akamaiproperty
```
## Instantiate the object.
```
>>> from akamaiproperty import AkamaiProperty
>>> myProperty = AkamaiProperty("/Users/apadmana/.edgerc","test_bulkseach_update_1","<accountSwitchKey>")
>>> myProperty = AkamaiProperty("/Users/apadmana/.edgerc","test_bulkseach_update_1")
```
## Print Basic Information
```
>>> myProperty.printPropertyInfo()
Property Name: test_bulkseach_update_1
Contract Id: ctr_C-1IE2OHM
Group Id: grp_163363
Active Staging Version: 18
Active Production Version: 18
```
## Create a new version
```
>>> myProperty.createVersion(18)
'78'
```
## Get rule Tree
```
>>>myProperty.getRuleTree(18)
{'accountId': 'act_B-C-1IE2OH8', 'contractId': 'ctr_C-1IE2OHM', 'groupId': 'grp_163363', 'propertyId': 'prp_605086', 'propertyName': 'test_bulkseach_update_1', 'propertyVersion': 18, 'etag': 'd0d28a6b71e665144955f7f7e1ff214933d119d7', 'rules':.....}
```
## Activate the config
```
>>>myProperty.activateStaging(18,"testing activation",["apadmana@akamai.com"])
True
```
## Class Definition
```
class AkamaiProperty():
def __init__(self,edgercLocation, name, accountSwitchKey=None):
self.name = name
self.contractId = ''
self.groupId = ''
self.propertyId = ''
self.stagingVersion = 0
self.productionVersion = 0
self.accountSwitchKey = ''
def printPropertyInfo(self)
def getStagingVersion(self)
def getProductionVersion(self)
def getRuleTree(self,version)
def updateRuleTree(self,version,jsondata)
def createVersion(self,baseVersion)
def activateStaging(self,version,notes,email_list)
def activateProduction(self,version,notes,email_list,peer_review_email,customer_email)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Achuthananda/AkamaiHTTPHandler",
"name": "akamaihttp",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Achuthananda M P",
"author_email": "achuthadivine@gmail.com",
"download_url": "",
"platform": "",
"description": "# A Python Class for Akamai Property\nAn Object oriented implementation of Akamai Property.\nThe advantage of Akamai Property class is application developers need not know about the PAPI calls and their usage. Application developers can just focus on getting their work done on Property Manager configs programmatically using the objects of AkamaiProperty.\n\n\n### Credentials\nIn order to use this configuration, you need to:\n* Set up your credential files as described in the [authorization](https://developer.akamai.com/introduction/Prov_Creds.html) and [credentials](https://developer.akamai.com/introduction/Conf_Client.html) sections of the getting started guide on developer.akamai.com. \n* When working through this process you need to give grants for the property manager API and the User Admin API (if you will want to move properties). The section in your configuration file should be called 'papi'.\n\n## Overview\nThe advantage of Akamai Property class is application developers need not know about the PAPI calls and their usage. Application developers can just focus on getting their work done on Property Manager configs programmatically using the objects of AkamaiProperty.\n\n\n## Install Dependencies If you are using source code.\n```\n$ pip install -r requirements.txt\n```\n\n### Install pip package available\n```\n$ pip install akamaiproperty\n```\n\n## Instantiate the object.\n```\n>>> from akamaiproperty import AkamaiProperty\n>>> myProperty = AkamaiProperty(\"/Users/apadmana/.edgerc\",\"test_bulkseach_update_1\",\"<accountSwitchKey>\")\n>>> myProperty = AkamaiProperty(\"/Users/apadmana/.edgerc\",\"test_bulkseach_update_1\")\n```\n\n## Print Basic Information\n```\n>>> myProperty.printPropertyInfo()\nProperty Name: test_bulkseach_update_1\nContract Id: ctr_C-1IE2OHM\nGroup Id: grp_163363\nActive Staging Version: 18\nActive Production Version: 18\n```\n## Create a new version\n```\n>>> myProperty.createVersion(18)\n'78'\n```\n\n## Get rule Tree\n```\n>>>myProperty.getRuleTree(18)\n{'accountId': 'act_B-C-1IE2OH8', 'contractId': 'ctr_C-1IE2OHM', 'groupId': 'grp_163363', 'propertyId': 'prp_605086', 'propertyName': 'test_bulkseach_update_1', 'propertyVersion': 18, 'etag': 'd0d28a6b71e665144955f7f7e1ff214933d119d7', 'rules':.....}\n```\n\n## Activate the config\n```\n>>>myProperty.activateStaging(18,\"testing activation\",[\"apadmana@akamai.com\"])\nTrue\n```\n\n## Class Definition\n```\nclass AkamaiProperty():\n def __init__(self,edgercLocation, name, accountSwitchKey=None):\n self.name = name\n self.contractId = ''\n self.groupId = ''\n self.propertyId = ''\n self.stagingVersion = 0\n self.productionVersion = 0\n self.accountSwitchKey = ''\n\n def printPropertyInfo(self)\n def getStagingVersion(self)\n def getProductionVersion(self)\n def getRuleTree(self,version)\n def updateRuleTree(self,version,jsondata)\n def createVersion(self,baseVersion)\n def activateStaging(self,version,notes,email_list)\n def activateProduction(self,version,notes,email_list,peer_review_email,customer_email)\n```\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A Pip Package for Akamai HttpHandlder",
"version": "1.6.4",
"project_urls": {
"Homepage": "https://github.com/Achuthananda/AkamaiHTTPHandler"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "006ce9dc24738d6fd434de7136b07f9716646a469cf4294f481b92db2bbcefda",
"md5": "81ee17fcb2e585c4142de0e360bd998b",
"sha256": "18d29dd22f03dc4c5ad28da82cf476f57d4f232d2b32ab6a2049140ddf4e322c"
},
"downloads": -1,
"filename": "akamaihttp-1.6.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81ee17fcb2e585c4142de0e360bd998b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5565,
"upload_time": "2021-09-09T13:20:11",
"upload_time_iso_8601": "2021-09-09T13:20:11.986611Z",
"url": "https://files.pythonhosted.org/packages/00/6c/e9dc24738d6fd434de7136b07f9716646a469cf4294f481b92db2bbcefda/akamaihttp-1.6.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-09-09 13:20:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Achuthananda",
"github_project": "AkamaiHTTPHandler",
"github_not_found": true,
"lcname": "akamaihttp"
}
JSON
