TopoToolbox / pytopotoolbox

Python interface to TopoToolbox
https://topotoolbox.github.io/pytopotoolbox/
GNU General Public License v3.0
1 stars 3 forks source link

Installation as a dependency #67

Open bgailleton opened 2 weeks ago

bgailleton commented 2 weeks ago

Hi, Now graphflood's PR is ready to merge, I'd like to add pytopotoolbox as a dependency to my own tools. What is the best practice and/or future plan for automating installation? The docs refer to .whl but I could not find them. On the other hand if you have a CI that builds them it is straightforward to upload them to pypi for pip installs (literally a couple of command lines). If you want to build a sophisticated CI, there is also conda-forge but it requires a bit more work.

wkearn commented 2 weeks ago

I think the docs were a little optimistic, but we have not provided built wheels or anything similar: you would have to build them yourself and then use them as needed. If you wanted to start using pytopotoolbox as a dependency immediately, the best way is probably with a dependency on the git repository if that is possible with your build system.

At some point we do want to make pytopotoolbox available through PyPI. Technically I think we have more or less everything we need for PyPI submission, but I have been holding off on it because we don't have a great system for versioning and releasing things cleanly, especially managing the libtopotoolbox dependency. I will start working on making that happen, though.

bgailleton commented 2 weeks ago

OK thanks for the reply! No rush, I can include a pre-compiled version in my own wheel in the meantime for linux and windows.

wkearn commented 2 weeks ago

I'd like to leave this open to track progress on the installation process, if that is all right.