High level API, how to do it?

[Jonathan Kinred]

At the moment psphere is a Python implementation of the vSphere Web Services SDK. It gives Python programmers access to the complete API in a reasonably Pythonic way. This power comes at a price, which is having to understand the underlying API.

My goal has always been to create a higher level library for users who just want to do basic operations. I'm quite keen to start on the design of this library.

There are three options I can think of:
1. A completely different project

• psphere would just be a dependency
  

2. Re-namespacing the existing project into psphere.api and introducing the higher level library as psphere

• psphere.api.managedobjects.VirtualMachine would be the low level VirtualMachine class implementing the vSphere SDK
• psphere.managedobjects.VirtualMachine would be the high level VirtualMachine class with high level helper methods

3. Introducing a new namespace for the higher level library:

• psphere.managedobjects.VirtualMachine would be the low level VirtualMachine class
• psphere.prime.managedobjects.VirtualMachine would be the high level VirtualMachine class with high level helper methods

Option 1 breaks up the project which might not be ideal.

Option 2 is backwards incompatible but provides a nicer namespace.

Option 3 is backwards compatible but the namespace isn't quite as nice.

[Noorul Islam Kamal Malmiyoda]

Please make it backward compatible. I have used this library extensively.

[Jonathan Kinred]

Thanks Noorul, feedback of psphere users is very important. With open source projects, it's hard to know if you even have users, let alone how extensively they're using the software!

[preet...@gmail.com]

Hi Jonathan,

I was planning on using this library. Do you have plans for breaking the backward compatibility?

Regards,

Litty

[Jonathan Kinred]

No I won't be breaking backwards compatibility. Of the options mentioned above I decided (but haven't made any progress) on Option 1.

Jonathan

--
You received this message because you are subscribed to the Google Groups "psphere" group.
To unsubscribe from this group and stop receiving emails from it, send an email to psphere+u...@googlegroups.com.
To post to this group, send an email to psp...@googlegroups.com.
To view this discussion on the web, visit https://groups.google.com/d/msgid/psphere/5d6e1fba-8c25-490c-aeab-1f504f1f0d1e%40googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.