OpenVSP python API pip package - proposal

213 views
Skip to first unread message

cibinj...@gmail.com

unread,
Mar 17, 2022, 5:19:35 AM3/17/22
to OpenVSP
Rob,

I keep seeing queries on how to install the python API for OpenVSP.
I can set up a pip package for the API if you're interested. I could add it to Travis to upgrade at each version too.
Users would then be able to 
1. install the API by doing "pip install openvsp" 
2. install a specific version by doing "pip install 'openvsp==3.25'" or 

This can be done for all sorts of environments like Anaconda through pip too.

- Cibin

gu mamang

unread,
Mar 17, 2022, 7:23:05 AM3/17/22
to OpenVSP
great idea! make it  easy and trival. 

Brandon Litherland

unread,
Mar 17, 2022, 8:26:12 AM3/17/22
to OpenVSP
Interesting idea to make the version optional.  In general, I don't use the PowerShell script to install the API.  I just use the "pip install -r requirements-dev.txt" in whatever environment I built that version of VSP in.
I'm not sure that it's particularly difficult to get the API going on any given system or IDE but sometimes knowing what steps to take to troubleshoot can be tricky.  

Rob McDonald

unread,
Mar 17, 2022, 12:38:13 PM3/17/22
to ope...@googlegroups.com
I am interested in any progress to make this easier for users.

I don't know much about the Python packaging system -- and have been unable to find good documentation and tutorials.  So I'd love for someone who understands this stuff to take the lead.

One caution -- I've heard that the Python packaging systems require any binary components (which the vsp API for Python is one) need to be compiled for many/most of the platforms that they support.  Right now, we are only set up for Intel Windows/Linux/MacOS -- I believe that working for inclusion in mainstream packaging system may greatly increase the number of platforms we need to build for.

Also, just as a note.  We moved away from Travis CI because of their change in billing structure about a year ago.  We now do our builds using GitHub Actions.

Rob


--
You received this message because you are subscribed to the Google Groups "OpenVSP" group.
To unsubscribe from this group and stop receiving emails from it, send an email to openvsp+u...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/openvsp/b1baf8fa-4935-4dc8-95b7-d996e37c2ad7n%40googlegroups.com.

Cibin Joseph

unread,
Mar 17, 2022, 2:01:03 PM3/17/22
to ope...@googlegroups.com
I've generally had good experiences with pip. It's similar to apt where all versions of a package are hosted on a server (pypi.org) and your "pip install" command searches for the latest package version and resolves dependencies. I have a few python projects that use pip and have a workflow/scripts I utilize for updating the package versions automatically.

@Brandon, the "==version" command is actually part of pip. Quite helpful for packages in constant development.
@Rob, I wasn't aware of the binary package issue though; I'll look into that. Had forgotten VSP moved on from Travis too!

I'll take a look at this in my free time and get back in a while.

Thanks,
Cibin

Roberto Martínez

unread,
Jul 8, 2024, 7:46:23 AM7/8/24
to OpenVSP
Hi everyone, 

I revamp this thread since the same idea as Cibin Joseph occured to me and a quick Google search brought me here. We use poetry for our enviroments and it would be very interesting to have openvsp in pip. Has there been any progress since the messages? Otherwise I am happy to perhaps giving it a try :)

Thanks,
Rober

Cibin Joseph

unread,
Jul 8, 2024, 11:49:41 AM7/8/24
to ope...@googlegroups.com
Roberto,
I remember taking a shot at it. But it required more time than I had. So I ended up moving on from the attempt.

Cibin

Reply all
Reply to author
Forward
0 new messages