<html><body><div style="color:#000; background-color:#fff; font-family:HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif;font-size:10pt"><div>Sean,</div><div>If you can point me to the project file in github which needs to be modified , i will include these docs</div><div><br></div><div style="color: rgb(0, 0, 0); font-size: 13px; font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; background-color: transparent; font-style: normal;">Thanks</div><div style="color: rgb(0, 0, 0); font-size: 13px; font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; background-color: transparent; font-style: normal;">Rajdeep</div><div class="yahoo_quoted" style="display: block;"> <br> <br> <div style="font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; font-size: 10pt;"> <div style="font-family: HelveticaNeue, 'Helvetica Neue',
Helvetica, Arial, 'Lucida Grande', sans-serif; font-size: 12pt;"> <div dir="ltr"> <font size="2" face="Arial"> On Sunday, February 9, 2014 9:04 PM, "Collins, Sean" <Sean_Collins2@cable.comcast.com> wrote:<br> </font> </div> <div class="y_msg_container"><div id="yiv9675694438"><style type="text/css">#yiv9675694438 P {margin-top:0;margin-bottom:0;}</style><div>
<div style="direction: ltr; font-family: Tahoma; color: rgb(0, 0, 0); font-size: 10pt;">Do you have plans to submit these back upstream? It would be a great first start, perhaps we could add these as examples underneath the JSON request/reponse in http://api.openstack.org/api-ref-networking.html<br clear="none">
<div><br clear="none">
<div style="font-family: Tahoma; font-size: 13px;">Sean M. Collins<br clear="none">
</div>
</div>
<div class="yiv9675694438yqt0075398357" id="yiv9675694438yqt55367"><div style="font-family: 'Times New Roman'; color: rgb(0, 0, 0); font-size: 16px;">
<hr tabindex="-1">
<div id="yiv9675694438divRpF258394" style="direction:ltr;"><font color="#000000" face="Tahoma" size="2"><b>From:</b> Rajdeep Dua [dua_rajdeep@yahoo.com]<br clear="none">
<b>Sent:</b> Saturday, February 08, 2014 11:10 PM<br clear="none">
<b>To:</b> OpenStack Development Mailing List (not for usage questions)<br clear="none">
<b>Subject:</b> Re: [openstack-dev] [Neutron] Using Python-Neutronclient from Python - docstrings needed?<br clear="none">
</font><br clear="none">
</div>
<div></div>
<div>
<div style="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; font-size: 10pt;">
<div><span>Sean,</span></div>
<div style="color: rgb(0, 0, 0); font-size: 13px; font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; background-color: transparent; font-style: normal;">
<span>We have written a few docs for writing these samples</span></div>
<div style="color: rgb(0, 0, 0); font-size: 13px; font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; background-color: transparent; font-style: normal;">
<span><br clear="none">
</span></div>
<div style="background-color:transparent;"><span>http://python-api-guide.cfapps.io/content/neutron.html<br clear="none">
</span></div>
<div style="background-color: transparent; color: rgb(0, 0, 0); font-size: 13px; font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; font-style: normal;">
<span><br clear="none">
</span></div>
<div style="background-color: transparent; color: rgb(0, 0, 0); font-size: 13px; font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; font-style: normal;">
<span>You can find get the source here https://github.com/rajdeepd/openstack-samples</span></div>
<div style="background-color: transparent; color: rgb(0, 0, 0); font-size: 13px; font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; font-style: normal;">
<span><br clear="none">
</span></div>
<div style="background-color: transparent; color: rgb(0, 0, 0); font-size: 13px; font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; font-style: normal;">
<span>Thanks</span></div>
<div style="background-color: transparent; color: rgb(0, 0, 0); font-size: 13px; font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; font-style: normal;">
Rajdeep</div>
<div class="yiv9675694438yahoo_quoted" style="display: block;"><br clear="none">
<br clear="none">
<div style="font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; font-size: 10pt;">
<div style="font-family: HelveticaNeue, 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif; font-size: 12pt;">
<div dir="ltr"><font face="Arial" size="2">On Sunday, February 9, 2014 12:57 AM, "Collins, Sean" <Sean_Collins2@cable.comcast.com> wrote:<br clear="none">
</font></div>
<div class="yiv9675694438y_msg_container">Hi,<br clear="none">
<br clear="none">
I was writing a small script yesterday to parse a list of IP blocks and<br clear="none">
create security groups and rules, by using python-neutronclient.<br clear="none">
<br clear="none">
To be honest, it was very difficult - even though I have actually<br clear="none">
written extensions to Python-Neutronclient for the QoS API. <br clear="none">
<br clear="none">
For those that are trying to use the client from inside their code,<br clear="none">
they end up getting zero help as to how to actually call any of the<br clear="none">
functions, and what parameters they take. <br clear="none">
<br clear="none">
<br clear="none">
>>> neutron = client.Client('2.0', auth_url=os.environ['OS_AUTH_URL'],<br clear="none">
... tenant_id=os.environ['OS_TENANT_ID'],<br clear="none">
... username=os.environ['OS_USERNAME'],<br clear="none">
... password=os.environ['OS_PASSWORD'])<br clear="none">
>>> help(neutron)<br clear="none">
<br clear="none">
| create_credential = <function with_params><br clear="none">
| <br clear="none">
| create_firewall = <function with_params><br clear="none">
| <br clear="none">
| create_firewall_policy = <function with_params><br clear="none">
| <br clear="none">
| create_firewall_rule = <function with_params><br clear="none">
| <br clear="none">
| create_floatingip = <function with_params><br clear="none">
| <br clear="none">
| create_health_monitor = <function with_params><br clear="none">
| <br clear="none">
| create_ikepolicy = <function with_params><br clear="none">
| <br clear="none">
| create_ipsec_site_connection = <function with_params><br clear="none">
| <br clear="none">
| create_ipsecpolicy = <function with_params><br clear="none">
| <br clear="none">
| create_member = <function with_params><br clear="none">
| <br clear="none">
| create_metering_label = <function with_params><br clear="none">
<br clear="none">
<br clear="none">
Since there was nothing there, I decided to go check the source of<br clear="none">
python-neutronclient and see if there are any examples.<br clear="none">
<br clear="none">
<a rel="nofollow" shape="rect" target="_blank" href="https://github.com/openstack/python-neutronclient/blob/master/doc/source/index.rst">https://github.com/openstack/python-neutronclient/blob/master/doc/source/index.rst</a><br clear="none">
<br clear="none">
If you read closely enough, you'll find out that the function takes a<br clear="none">
dictionary, that looks very similar to the request/response examples<br clear="none">
listed in the API documentation. So, I went over and checked it out.<br clear="none">
<br clear="none">
<a rel="nofollow" shape="rect" target="_blank" href="http://docs.openstack.org/api/openstack-network/2.0/content/POST_security-groups-v2.0_createSecGroup_v2.0_security-groups_security-groups-ext.html">http://docs.openstack.org/api/openstack-network/2.0/content/POST_security-groups-v2.0_createSecGroup_v2.0_security-groups_security-groups-ext.html</a><br clear="none">
<br clear="none">
So from there, I was able to remember enough that each of these<br clear="none">
functions takes a single argument, that is a dictionary, that mimics<br clear="none">
the same structure that you see in the API documentation, so from there<br clear="none">
it was just some experimentation to get the structure right.<br clear="none">
<br clear="none">
Honestly it wasn't easy to remember all this stuff, since<br clear="none">
it had been a couple months since I had worked with<br clear="none">
python-neutronclient, and it had been from inside the library itself.<br clear="none">
<br clear="none">
This was my first experience using it "on the outside" and it was pretty<br clear="none">
tough - so I'm going to try and look into how we can improve the<br clear="none">
docstrings for the client object, to make it a bit easier to figure out.<br clear="none">
<br clear="none">
Thoughts?<br clear="none">
<br clear="none">
-- <br clear="none">
Sean M. Collins<br clear="none">
_______________________________________________<br clear="none">
OpenStack-dev mailing list<br clear="none">
<a rel="nofollow" shape="rect" ymailto="mailto:OpenStack-dev@lists.openstack.org" target="_blank" href="mailto:OpenStack-dev@lists.openstack.org">OpenStack-dev@lists.openstack.org</a><br clear="none">
<a rel="nofollow" shape="rect" target="_blank" href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br clear="none">
<br clear="none">
<br clear="none">
</div>
</div>
</div>
</div>
</div>
</div>
</div></div>
</div>
</div></div><br><br></div> </div> </div> </div> </div></body></html>