Updated readme

Author: chillaq

README.md

@@ -1,4 +1,4 @@
-# Split Python API
+# Split Python Admin API
 
 This API wrapper is designed to work with [Split](https://www.split.io), the platform for controlled rollouts, serving features to your users via the Split feature flag to manage your complete customer experience.
 
@@ -7,55 +7,85 @@ This API wrapper is designed to work with [Split](https://www.split.io), the pla
 For specific instructions on how to use this API refer to our [official API documentation](https://docs.split.io/reference).
 
 Install the split-admin-api:
+
 `pip install split-admin-api`
 
 Import the client object and initialize connection using an Admin API Key:
-`from splitapiclient.main import get_client
+
+```
+from splitapiclient.main import get_client
 client = get_client({'apikey': 'ADMIN API KEY'})
-`
+```
 Enable optional logging:
-`import logging
+
+```
+import logging
 logging.basicConfig(level=logging.DEBUG)
-`
+```
+
 **Workspaces**
+
 Fetch all workspaces:
-`for ws in client.workspaces.list():
+
+```
+for ws in client.workspaces.list():
     print ("\nWorkspace:"+ws.name+", Id: "+ws.id)
-`
-Find a specific workspaces:
-`ws = client.workspaces.find("Defaults")
+```
+
+Find a specific workspace:
+
+```
+ws = client.workspaces.find("Defaults")
 print ("\nWorkspace:"+ws.name+", Id: "+ws.id)
-`
+```
+
 **Environments**
+
 Fetch all Environments:
-`ws = client.workspaces.find("Defaults")
+
+```
+ws = client.workspaces.find("Defaults")
 for env in client.environments.list(ws.id):
     print ("\nEnvironment: "+env.name+", Id: "+env.id)
+```
+
 Add new environment:
-`ws = client.workspaces.find("Defaults")
+
+```
+ws = client.workspaces.find("Defaults")
 env = ws.add_environment({'name':'new_environment', 'production':False})
-`
+```
 
 **Splits**
+
 Fetch all Splits:
-`ws = client.workspaces.find("Defaults")
+
+```
+ws = client.workspaces.find("Defaults")
 for split in client.splits.list(ws.id):
     print ("\nSplit: "+split.name+", "+split._workspace_id)
-`
+```
+
 Add new Split:
-`
+
+```
 split = ws.add_split({'name':'split_name', 'description':'new UI feature'}, "user")
 print(split.name)
-`
+```
+
 Add tags:
-`
+
+```
 split.associate_tags(['my_new_tag', 'another_new_tag'])
-`
+```
+
 Add Split to environment:
-`
+
+```
 ws = client.workspaces.find("Defaults")
 split = client.splits.find("new_feature", ws.id) 
 env = client.environments.find("Production", ws.id)
+
 tr1 = treatment.Treatment({"name":"on","configurations":""})
 tr2 = treatment.Treatment({"name":"off","configurations":""})
 bk1 = bucket.Bucket({"treatment":"on","size":50})
@@ -65,106 +95,202 @@ cond = condition.Condition({'matchers':[match.export_dict()]})
 rl = rule.Rule({'condition':cond.export_dict(), 'buckets':[bk1.export_dict(), bk2.export_dict()]})
 defrl = default_rule.DefaultRule({"treatment":"off","size":100}) 
 data={"treatments":[tr1.export_dict() ,tr2.export_dict()],"defaultTreatment":"off", "baselineTreatment": "off","rules":[rl.export_dict()],"defaultRule":[defrl.export_dict()], "comment": "adding split to production"}
+
 splitdef = split.add_to_environment(env.id, data)
-`
+```
+
 Kill Split:
-`
+
+```
 ws = client.workspaces.find("Defaults")
 env = client.environments.find("Production", ws.id)
 splitDef = client.split_definitions.find("new_feature", env.id, ws.id)
 splitDef.kill()
-`
+```
+
 Restore Split:
-`
+
+```
 splitDef.restore()
-`
+```
+
 Fetch all Splits in an Environment:
-`
+
+```
 ws = client.workspaces.find("Defaults")
 env = client.environments.find("Production", ws.id)
 for spDef in client.split_definitions.list(env.id, ws.id):
     print(spDef.name+str(spDef._default_rule))
-`
+```
+
 Submit a Change request to update a Split definition:
-`
+
+```
 splitDef = client.split_definitions.find("new_feature", env.id, ws.id)
 definition= {"treatments":[ {"name":"on"},{"name":"off"}],
     "defaultTreatment":"off", "baselineTreatment": "off",
     "rules": [],
     "defaultRule":[{"treatment":"off","size":100}],"comment": "updating default rule"
 }
 splitDef.submit_change_request(definition, 'UPDATE', 'updating default rule', 'comment', ['[email protected]'], '')
-`
+```
+
 List all change requests:
-`
+
+```
 for cr in client.change_requests.list():
     if cr._split is not None:
         print (cr._id+", "+cr._split['name']+", "+cr._title+", "+str(cr._split['environment']['id'])) 
     if cr._segment is not None:
         print (cr._id+", "+cr._segment['name']+", "+cr._title)
-`
+```
+
 Approve specific change request:
-`
+
+```
 for cr in client.change_requests.list():
     if cr._split['name']=='new_feature':
         cr.update_status("APPROVED", "done")
-`
+```
+
+**Segments**
+
+Fetch all Segments:
+
+```
+ws = client.workspaces.find("Defaults")
+for seg in client.segments.list(ws.id):
+    print (seg.name)
+```
+
+Fecth all Segments in an Environment:
+
+```
+ws = client.workspaces.find("Defaults")
+env = client.environments.find("Production", ws.id)
+for segDef in client.segment_definitions.list(env.id, ws.id):
+    print(segDef.name+", "+segDef._trafficType.name)
+
+```
+
+Add new Segment:
+
+```
+ws = client.workspaces.find("Defaults")
+seg = ws.add_segment({'name':'segment_from_python', 'description':'users'}, "user")
+```
+
+Add Segment to an Environment:
+
+```
+ws = client.workspaces.find("Defaults")
+env = client.environments.find("Production", ws.id)
+seg = client.segments.find("admin_api_test",ws.id)
+segDef = seg.add_to_environment(env.id)
+```
+
+Add Segment Keys:
+
+```
+ws = client.workspaces.find("Defaults")
+env = client.environments.find("Production", ws.id)
+segDef = client.segment_definitions.find("admin_api_test", env.id, ws.id)
+segDef.import_keys_from_json("false", {"keys":["id4", "id5", "id6"], "comment":"a comment"})
+```
+
+List Segment Keys:
+
+```
+ws = client.workspaces.find("Defaults")
+env = client.environments.find("Production", ws.id)
+segDef = client.segment_definitions.find("admin_api_test", env.id, ws.id)
+for key in segDef.get_keys():
+    print(key)
+```
+
+Export Segment Keys to csv:
+
+```
+ws = client.workspaces.find("Defaults")
+env = client.environments.find("Production", ws.id)
+segDef = client.segment_definitions.find("admin_api_test", env.id, ws.id)
+segDef.export_keys_to_csv("seg.csv")
+```
+
 **Users and Groups**
+
 Fetch all Active users:
-`
+
+```
 for user in client.users.list('ACTIVE'):
     print(user.email+", "+user._id) 
-`
+```
+
 Invite new user:
-`
+
+```
 group = client.groups.find('Administrators')
 userData = {'email':'[email protected]', 'groups':[{'id':'', 'type':'group'}]}
 userData['groups'][0]['id'] = group._id
 client.users.invite_user(userData)
-`
+```
+
 Delete a pending invite:
-`
+
+```
 for user in client.users.list('PENDING'):
     print(user.email+", "+user._id+", "+user._status)
     if user.email == '[email protected]': 
         client.users.delete(user._id)
-`
+```
+
 Update user info:
-`
+
+```
 data = {'name':'new_name', 'email':'[email protected]', '2fa':False, 'status':'ACTIVE'}
 user = client.users.find('[email protected]')
 user.update_user(user._id, data)
-`
+```
+
 Fetch all Groups:
-`
+
+```
 for group in client.groups.list():
     print (group._id+", "+group._name)
-`
+```
+
 Create Group:
-`
+
+```
 client.groups.create_group({'name':'new_group', 'description':''})
-`
+```
+
 Delete Group:
-`
+
+```
 group = client.groups.find('new_group')
 client.groups.delete_group(group._id)
-`
+```
+
 Replace existing user group:
-`
+
+```
 user = client.users.find('[email protected]')
 group = client.groups.find('Administrators')
 data = [{'op': 'replace', 'path': '/groups/0', 'value': {'id': '<groupId>', 'type':'group'}}]
 data[0]['value']['id'] = group._id
 user.update_user_group(data)
-`
+```
+
 Add user to new group
-`
+
+```
 user = client.users.find('[email protected]')
 group = client.groups.find('Administrators')
 data = [{'op': 'add', 'path': '/groups/-', 'value': {'id': '<groupId>', 'type':'group'}}]
 data[0]['value']['id'] = group._id
 user.update_user_group(data)
-`
+```
 
 ### Commitment to Quality:
 
@@ -185,3 +311,4 @@ Visit [split.io/product](https://www.split.io/product) for an overview of Split,
 **System Status:**
 
 We use a status page to monitor the availability of Split’s various services. You can check the current status at [status.split.io](http://status.split.io).
+