python-dracclient

Ewan Hamilton ewan.hamilton at managed.co.uk
Mon Jun 15 21:22:01 UTC 2020


Hi guys, sorry for my tone in the post – I was extremely frustrated at how a simple thing can be missed out. I write documentation for staff at my work and I know just how basic you have to be in order for them to understand it.

I was able to get this working using:

from dracclient import client
service_instance = connect.SmartConnectNoSSL(host="x", user="x", pwd="x")

Looking into it further, the author has another project called python-wsmanclient so I think he just got confused writing the documentation examples.

My apologies again for my tone – I’m happy again now that it’s working!

Ewan



Ewan Hamilton
3rd Line Networks Analyst
 t: 0800 033 4800  
ext. 2212 | 
m: 07772 001 625
​Technology House, 151 Silbury Boulevard, Milton Keynes, MK9 1LH
managed. is a trading name of Managed247 Ltd
​Managed247 Ltd is a company registered in England and Wales under number 7019261
From: Julia Kreger <juliaashleykreger at gmail.com>
Sent: 15 June 2020 21:17
To: Ewan Hamilton <ewan.hamilton at managed.co.uk>
Cc: openstack-discuss at lists.openstack.org
Subject: Re: python-dracclient

THIS MESSAGE ORIGINATED OUTSIDE YOUR ORGANISATION
________________________________
Greetings,

Wow! Thanks for the heads up on this. It is kind of shockingly sparse... and I think the docs are being incorrectly published for that library as well.

Anyway, I _think_ what the original author meant was for "dracclient" to be imported as "wsmanclient". The structure seems to match up with that. Looking at the existing code, it states "dracclient.client.DRACClient". That changed over four years ago so I think what you're viewing is a very old copy of the documentation that was once published in the openstack project namespace.

As for where, I don't think it is presently being published, which makes this problem ultimately worse. I'm going to reach out to the maintainers and inquire if they can fix the larger issue of their docs publishing.

Again, Thanks for the heads up.

-Julia

p.s. https://review.opendev.org/735674


On Mon, Jun 15, 2020 at 11:04 AM Ewan Hamilton <ewan.hamilton at managed.co.uk<mailto:ewan.hamilton at managed.co.uk>> wrote:
Hi guys,

Your documentation for python-dracclient begins here: https://docs.openstack.org/python-dracclient/latest/usage.html  with


Usage
Create a client object by providing the connection details of the DRAC card:

client = wsmanclient.client.DRACClient('1.2.3.4', 'username', 's3cr3t')


There is no import statement – and when I have searched google and found “import dracclient” because the assumed “import python-dracclient” doesn’t work due to a hyphen (why would you name your module with a hyphen in the first place?!), it doesn’t recognise “wsmanclient” in the editor still.

Can you see just how frustrating this is for someone who expects documentation that actually works and explains how to actually use the module?

This is a pathetic job here.


[cid:image001.png at 01D64363.2BCCBE70]
Ewan Hamilton​
3rd Line Networks Analyst
 t: 0800 033 4800
ext. 2212<tel:2212>
 |
m: 07772 001 625
[LinkedIn]<https://www.linkedin.com/company/managed247-ltd/>
[Twitter]<https://twitter.com/managed247>
[Website]<http://www.managed.co.uk/>
​Technology House, 151 Silbury Boulevard, Milton Keynes, MK9 1LH
managed. is a trading name of Managed247 Ltd
​Managed247 Ltd is a company registered in England and Wales under number 7019261

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20200615/56ea8010/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image001.png
Type: image/png
Size: 6379 bytes
Desc: image001.png
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20200615/56ea8010/attachment-0008.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image002.png
Type: image/png
Size: 833 bytes
Desc: image002.png
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20200615/56ea8010/attachment-0009.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image003.png
Type: image/png
Size: 959 bytes
Desc: image003.png
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20200615/56ea8010/attachment-0010.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image004.png
Type: image/png
Size: 1196 bytes
Desc: image004.png
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20200615/56ea8010/attachment-0011.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image672279.png
Type: image/png
Size: 6379 bytes
Desc: image672279.png
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20200615/56ea8010/attachment-0012.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image340246.png
Type: image/png
Size: 833 bytes
Desc: image340246.png
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20200615/56ea8010/attachment-0013.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image818723.png
Type: image/png
Size: 959 bytes
Desc: image818723.png
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20200615/56ea8010/attachment-0014.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image841784.png
Type: image/png
Size: 1196 bytes
Desc: image841784.png
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20200615/56ea8010/attachment-0015.png>


More information about the openstack-discuss mailing list